Połącz swoje narzędzia z zamówieniami, dostępnym zapasem i śledzeniem przesyłek przez REST API, SDK TypeScript i webhooki.
Otwórz portal deweloperski, aby sprawdzić interfejsy API dostępne dla Twojego konta i SDK udostępnione w Twoim środowisku. Wymagane są logowanie i odpowiednie uprawnienia konta.
TypeScript SDK
Przykład TypeScript uruchamiany na serwerze z klientem Ysend. Ustaw bazowy adres API uzgodniony podczas wdrożenia i przechowuj klucz API w zmiennych środowiskowych serwera.
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });Przykład wymaga inventory:read, orders:read i shipments:read. Przy zapisie przez SDK podaj stały Idempotency-Key, aby umożliwić ponawianie prób bez tworzenia drugiej operacji.
Użyj Node.js 20 lub nowszego. Jeśli portal udostępnia SDK, zapisz wersję i nazwę pliku, a następnie sprawdź SHA-256 pobranego pliku. Zastąp PACKAGE_FILE.tgz poniżej dokładną nazwą tego pliku.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL musi zawierać uzgodniony adres API: protokół HTTPS i host, bez /api/v1. SDK dodaje tę ścieżkę. Przechowuj YSEND_API_KEY na serwerze; żądania używają X-Api-Key.
Każde wywołanie listy zwraca jedną stronę. Podaj page i pageSize, a przed pobraniem kolejnych stron sprawdź items, totalCount, page i pageSize, jeśli zostały zwrócone. Pierwsza strona nie jest pełnym eksportem.
YsendError udostępnia dostępny status HTTP, detail i traceId. YsendTransportError oznacza brak odpowiedzi, którą można wykorzystać; wynik operacji zapisu może wtedy pozostać nieznany.
Domyślnie: trzy próby łącznie i 30 sekund oczekiwania na nagłówki odpowiedzi przy każdej próbie. GET/HEAD oraz żądania z Idempotency-Key mogą być ponawiane po błędzie sieci lub HTTP 429, 502, 503 albo 504. Używaj tego samego klucza dla tej samej operacji. orders.list używa POST bez tego klucza i nie jest w ten sposób automatycznie ponawiane.
Brak dostępu lub SDK? W zapytaniu dotyczącym projektu opisz wymianę danych, którą chcesz przetestować. Przed testami potwierdź adres API, wersję pakietu, właściwą dokumentację API, konto testowe i uprawnienia. Nie dołączaj sekretów.
Zacznij
Po aktywacji konta uprawniony administrator tworzy klucz z uprawnieniami potrzebnymi integracji.
Jeśli w Twoim środowisku opublikowano pakiet SDK, pobierz go z portalu deweloperskiego, sprawdź sumę SHA-256 i zainstaluj pobrany plik.
Odczytaj zapas, zamówienia i przesyłki w zakresie uprawnień swojego klucza.
Webhooki
Twórz subskrypcje w aplikacji, testuj je pingiem i sprawdzaj próby dostarczenia. Outbox ponawia próby przy odpowiednich błędach; zdarzenia po wyczerpaniu prób pozostają widoczne w kolejce błędów.
Zakres
Importuj CSV lub uporządkowane wiersze; sprawdzaj, poprawiaj i ponownie przesyłaj odrzucone wiersze.
Mapuj SKU i odczytuj zapas fizyczny, zarezerwowany oraz dostępny.
Przygotowuj plany dostaw, dodawaj pozycje, wnioskuj o terminy i śledź rozbieżności przyjęcia.
Odczytuj przewoźnika, śledzenie i status dostawy po utworzeniu przesyłki podczas realizacji zamówienia.
Otwórz sprawę powiązaną z zamówieniem i dołącz zdjęcia lub dokumenty.
Odczytuj subskrypcje i historię dostarczeń ze swojej integracji.
Klucze partnerskie
Przechowuj klucze na serwerze. Uprawnienia konta i partnera określają zakres każdej operacji; uprawnieni administratorzy zarządzają tworzeniem i rotacją kluczy oraz subskrypcjami webhooków w odpowiednim portalu.
Przedstaw przepływy danych i potrzebne operacje. Potwierdzimy dostęp, uprawnienia i pakiet SDK dla Twojej integracji.
Zespół Ysend pomoże dobrać usługi, integracje i harmonogram dla Twojej firmy.