Bestellungen anlegen, Rechnungen freigeben und bezahlen und den Workspace einrichten.

Endpunktsuche

Käufer-API durchsuchen

146 Endpunkte in 19 Ressourcen. Suchen Sie nach Pfad, Methode oder dem, was Sie tun möchten – fügen Sie eine echte URL ein, und ihre IDs passen auf die Parameter des Pfads.

/

Beispiele

API-Referenz

Die Pleaxy-API ist eine REST-API mit JSON-Anfragen und -Antworten. Mit ihr lesen und erstellen Sie Bestellungen und Rechnungen und verfolgen sie durch Freigabe und Zahlung. Konzepte und Anleitungen finden Sie in der Dokumentation.

Authentifizierung

Senden Sie mit jeder Anfrage einen von zwei Headern:

X-Api-Key: <keyId>.<secret> – ein API-Schlüssel, für Ihre eigenen Systeme und Agenten.
Authorization: Bearer <accessToken> – die Sitzung einer angemeldeten Person, erforderlich für einige Aktionen wie Freigaben und die Verwaltung von API-Schlüsseln.

Eine Anmeldeinformation gilt in einem Workspace, als Käufer oder als Lieferant. Jeder Pfad enthält die ID dieses Workspace als regionId; Sie kopieren sie in Pleaxy unter Unternehmensprofil → Workspace-ID.

Fehler

Fehler verwenden 4xx-Statuscodes und einen JSON-Body. Verzweigen Sie anhand von code, nicht anhand der englischen message; mit messageId und params zeigen Sie die Meldung in Ihrer eigenen Sprache an.

Versionierung

Pfade beginnen mit der Version, /v1. Neue Endpunkte, Felder und Werte kommen innerhalb dieser Version hinzu. Ignorieren Sie daher unbekannte Felder und sehen Sie für unbekannte Werte wie Status einen Standard vor. Inkompatible Änderungen erscheinen als neue Version.

Basis-URL

https://api.pleaxy.ai

Authentifizierte Anfrage

curl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
  -H "X-Api-Key: $PLEAXY_API_KEY"

Fehler

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Invoice INV-7F3A9C21 not found.",
  "code": "string",
  "messageId": "string",
  "params": { ... }
}