Verbind uw systemen met bestellingen, beschikbare voorraad en zendingtracking via de REST-API, TypeScript-SDK en webhooks.
Open het ontwikkelaarsportaal voor de API’s waartoe uw account toegang heeft en de SDK die in uw omgeving beschikbaar is. Aanmelding en de juiste accountrechten zijn vereist.
TypeScript SDK
Een TypeScript-voorbeeld voor uw server met de Ysend-client. Stel de tijdens de onboarding afgesproken basis-URL van de API in en bewaar uw API-sleutel in de omgevingsvariabelen van uw server.
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 });Het voorbeeld vereist inventory:read, orders:read en shipments:read. Geef voor schrijfacties via de SDK een stabiele Idempotency-Key mee, zodat herhaalde pogingen geen tweede operatie aanmaken.
Gebruik Node.js 20 of hoger. Als het portaal een SDK aanbiedt, noteert u de versie en bestandsnaam en controleert u de SHA-256 van het gedownloade bestand. Vervang PACKAGE_FILE.tgz hieronder door die exacte bestandsnaam.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL bevat het afgesproken API-adres: HTTPS-protocol en host, zonder /api/v1. De SDK voegt dat pad toe. Bewaar YSEND_API_KEY op de server; aanvragen gebruiken X-Api-Key.
Elke lijstaanroep geeft één pagina terug. Geef page en pageSize op en controleer items, totalCount, page en pageSize wanneer deze zijn meegeleverd voordat u meer pagina’s opvraagt. De eerste pagina is geen volledige export.
YsendError bevat de beschikbare HTTP-status, detail en traceId. YsendTransportError betekent dat geen bruikbaar antwoord is ontvangen; de uitkomst van een schrijfactie kan dan onbekend zijn.
Standaard: drie pogingen in totaal en 30 seconden wachttijd op de antwoordheaders per poging. GET/HEAD en aanvragen met Idempotency-Key kunnen opnieuw worden geprobeerd na een netwerkfout of HTTP 429, 502, 503 of 504. Gebruik dezelfde sleutel voor dezelfde handeling. orders.list gebruikt POST zonder die sleutel en krijgt deze automatische herhalingen niet.
Geen toegang of SDK beschikbaar? Beschrijf de gegevensuitwisseling die u wilt testen in uw projectaanvraag. Laat vóór het testen het API-adres, de pakketversie, de toepasselijke API-referentie, het testaccount en de rechten bevestigen. Voeg geen geheimen toe.
Starten
Na activering van het account maakt een bevoegde beheerder een sleutel aan met de benodigde rechten voor uw integratie.
Als er een SDK-pakket voor uw omgeving is gepubliceerd, downloadt u het via het ontwikkelaarsportaal, controleert u de SHA-256 en installeert u het gedownloade bestand.
Vraag voorraad, bestellingen en zendingen op binnen de rechten van uw sleutel.
Webhooks
Maak abonnementen aan in de webapp, test ze met een ping en bekijk de afleverpogingen. De outbox probeert daarvoor geschikte fouten opnieuw; gebeurtenissen die hun pogingen hebben uitgeput, blijven zichtbaar in de foutwachtrij.
Reikwijdte
Importeer CSV-bestanden of gestructureerde regels; controleer en corrigeer geweigerde regels en dien ze opnieuw in.
Koppel SKU’s en lees fysieke, gereserveerde en beschikbare voorraad.
Bereid aanleverplannen voor, voeg regels toe, vraag tijdsloten aan en volg ontvangstverschillen.
Lees vervoerder, tracking en afleverstatus zodra de orderafhandeling de zending heeft aangemaakt.
Open een dossier bij een bestelling en voeg foto’s of documenten toe.
Bekijk abonnementen en aflevergeschiedenis vanuit uw integratie.
Partnersleutels
Bewaar sleutels op uw server. Account- en partnerrechten bepalen welke operaties mogelijk zijn; bevoegde beheerders beheren sleutels, sleutelrotatie en webhook-abonnementen in het bijbehorende portaal.
Deel uw gegevensstromen en benodigde operaties. Samen bevestigen we de toegang, rechten en het SDK-pakket voor uw integratie.
Het Ysend-team helpt u de diensten, koppelingen en planning voor uw bedrijf te bepalen.