Instalacja

Zainstaluj pakiet ESM z npm:

npm install @requiply/api-sdk

SDK wymaga Node.js 18 lub nowszego. Środowiska przeglądarkowe muszą udostępniać fetch, Headers, Response, URL i AbortSignal.

Importuj klienta i publiczne typy z głównego punktu wejścia pakietu:

import { RequiplyClient, RequiplyError } from '@requiply/api-sdk';
import type { InventoryListResponse } from '@requiply/api-sdk';

Utwórz jednego klienta dla organizacji Requiply:

const requiply = new RequiplyClient({
  apiKey: 'rq_pk_live_...',
});

Klient domyślnie wysyła żądania do https://api.requiply.com. Przekazuj baseUrl tylko wtedy, gdy chcesz skierować żądania gdzie indziej, na przykład do własnego serwera proxy. Klient dopisuje /api/public/v1 do ścieżki każdego zasobu i usuwa końcowe ukośniki z ustawionego adresu URL.

Pakiet udostępnia obecnie punkt wejścia do importu ESM. Użycie CommonJS nie jest opisane jako obsługiwane.