Fejlesztőknek
Kezdj bele
API-k/App API/Az első API-hívásod

Az első API-hívásod

Hogyan szerez a szervered App API-tokent, és hogyan listázza a bolt termékeit.

Ezen az oldalon

Az App API-t a szerveredről hívod meg a Poltura ID-ból származó hozzáférési tokennel: az appod sajátjával (a JWT-profil és a hozzá tartozó gépi felhasználó) vagy egy személy tokenjével az appodon keresztül. Minden hívás megadja a bolt telepítését a Poltura-Installation headerben. Mindkét esethez lásd az Auth oldalt.

A @poltura/app-sdk-ból származó PolturaClient elküldi a tokent és a telepítést az /apps-api/v1 endpointra. Kérdezd le a bolt adatait, majd járd be a terméklistát oldalanként, amíg a nextCursor értéke null nem lesz:

server.ts
async function listAllProducts(client: PolturaClient): Promise<string[]> {
  const titles: string[] = [];
  let cursor: string | undefined;
  do {
    const page = await client.products.list({ limit: 100, cursor });
    titles.push(...page.products.map((product) => product.title));
    cursor = page.nextCursor ?? undefined;
  } while (cursor !== undefined);
  return titles;
}

További tudnivalók

  • Hibák: PolturaRequestError formájában érkeznek egy code, egy HTTP status és egy requestId mezővel, amire hivatkozhatsz, ha segítséget kérsz. A rate_limited tartalmazza a retryAfterMs mezőt is. A teljes lista az App API oldalon található.
  • Írási műveletek: elfogadnak egy Idempotency-Key headert, így a megismételt kérés csak egyszer hajtódik végre. A tárolóba íráskor az alapul vett expectedVersion értéket is meg kell adnod.
  • Webhookok: jelzik, ha termékek vagy rendelések változnak, így nem kell folyamatosan lekérdezned őket. Lásd: Webhooks.
Utoljára frissítve