Verbinden Sie Ihre Systeme über REST-API, TypeScript-SDK und Webhooks mit Bestellungen, verfügbarem Bestand und Sendungsverfolgung.
Im Entwicklerportal finden Sie die für Ihr Konto zugänglichen APIs und das in Ihrer Umgebung verfügbare SDK. Anmeldung und entsprechende Kontoberechtigungen sind erforderlich.
TypeScript SDK
Ein serverseitiges TypeScript-Beispiel mit dem Ysend-Client. Konfigurieren Sie die beim Onboarding vereinbarte API-Basis-URL und speichern Sie den API-Schlüssel in den Umgebungsvariablen Ihres Servers.
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 });Das Beispiel benötigt inventory:read, orders:read und shipments:read. Übergeben Sie für SDK-Schreiboperationen einen stabilen Idempotency-Key, damit Wiederholungen keine zweite Operation erzeugen.
Verwenden Sie Node.js 20 oder neuer. Falls das Portal ein SDK anbietet, notieren Sie Version und Dateinamen und prüfen Sie den SHA-256-Wert der heruntergeladenen Datei. Ersetzen Sie PACKAGE_FILE.tgz unten durch diesen genauen Dateinamen.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL enthält die vereinbarte API-Adresse aus HTTPS-Protokoll und Host, ohne /api/v1. Diesen Pfad ergänzt das SDK. Bewahren Sie YSEND_API_KEY auf dem Server auf; Anfragen verwenden X-Api-Key.
Jeder Listenaufruf liefert eine Seite. Geben Sie page und pageSize an und prüfen Sie die gelieferten Angaben items, totalCount, page und pageSize, bevor Sie weitere Seiten abrufen. Die erste Seite ist kein vollständiger Export.
YsendError enthält den verfügbaren HTTP-Status, detail und traceId. YsendTransportError bedeutet, dass keine verwertbare Antwort eingegangen ist; das Ergebnis einer Schreiboperation kann dann unbekannt sein.
Standardmäßig gelten insgesamt drei Versuche und 30 Sekunden Wartezeit auf die Antwortheader pro Versuch. GET/HEAD sowie Anfragen mit Idempotency-Key können nach Netzwerkfehlern oder HTTP 429, 502, 503 oder 504 wiederholt werden. Verwenden Sie für dieselbe Operation denselben Schlüssel. orders.list verwendet POST ohne diesen Schlüssel und wird nicht auf diese Weise automatisch wiederholt.
Zugang oder SDK nicht verfügbar? Beschreiben Sie die zu testenden Datenflüsse in Ihrer Projektanfrage. Lassen Sie vor dem Test API-Adresse, Paketversion, gültige API-Referenz, Testkonto und Berechtigungen bestätigen. Übermitteln Sie keine Geheimnisse.
Loslegen
Nach der Kontoaktivierung erstellt ein berechtigter Administrator einen Schlüssel mit den benötigten Berechtigungen.
Wenn ein SDK-Paket für Ihre Umgebung veröffentlicht ist, laden Sie es im Entwicklerportal herunter, prüfen Sie den SHA-256-Wert und installieren Sie die heruntergeladene Datei.
Fragen Sie Bestand, Bestellungen und Sendungen innerhalb der Berechtigungen Ihres Schlüssels ab.
Webhooks
Erstellen Sie Abonnements in der Webanwendung, testen Sie diese mit einem Ping und prüfen Sie die Zustellversuche. Die Outbox wiederholt geeignete fehlgeschlagene Zustellungen; nach ausgeschöpften Versuchen bleiben Ereignisse in der Fehlerwarteschlange sichtbar.
Umfang
Importieren Sie CSV-Dateien oder strukturierte Zeilen; prüfen, korrigieren und übermitteln Sie abgelehnte Zeilen erneut.
Ordnen Sie SKUs zu und lesen Sie den physischen, reservierten und verfügbaren Bestand.
Bereiten Sie Anlieferpläne vor, ergänzen Sie Positionen, fragen Sie Zeitfenster an und verfolgen Sie Wareneingangsdifferenzen.
Lesen Sie Transportdienstleister, Tracking und Lieferstatus, sobald die Abwicklung eine Sendung erstellt hat.
Eröffnen Sie einen Fall zu einer Bestellung und fügen Sie Fotos oder Dokumente hinzu.
Lesen Sie Abonnements und Zustellverläufe über Ihre Integration.
Partnerschlüssel
Bewahren Sie Schlüssel auf Ihrem Server auf. Konto- und Partnerberechtigungen begrenzen jede Operation. Berechtigte Administratoren verwalten Schlüssel, Schlüsselwechsel und Webhook-Abonnements im jeweiligen Portal.
Bringen Sie Ihren Datenfluss und die benötigten Operationen mit. Gemeinsam klären wir Zugang, Berechtigungen und SDK-Paket.
Das Ysend-Team unterstützt Sie bei der Auswahl der Leistungen, Anbindungen und des Zeitplans für Ihr Unternehmen.