Public API & OpenAPI: Ein Vertrag, kein höflicher CSV-Export

Manche Tenants verbringen den ganzen Tag in ReVend OS. Andere haben längst ERP-, WMS-, Finanz- oder BI-Systeme, die nicht verschwinden, nur weil irgendwo ein hübscherer Button aufgetaucht ist. Für diese Teams gibt es die Public API: strukturierter Zugriff auf operative Records, ohne Copy-paste-Diplomatie.

Was die API abdeckt

Die produktive /v1-Fläche umfasst Assets, Orders, Evidence, Documents, Companies, Contacts, Firmenadressen, Warehouses, Katalogdaten, Sellable Assets, Listings, Auctions, Events, Webhooks und Import Jobs. Das ist kein Demo-Endpoint im Sakko; der Vertrag wird generiert, getestet und über OpenAPI veröffentlicht.

Import Jobs registrieren derzeit nur Anfragen. Automatische Verarbeitung und Dateiprüfung sind nicht verfügbar; die API gibt processing_available: false zurück. Verwenden Sie die unterstützten direkten Import-Endpoints, um Daten zu schreiben.

OpenAPI

/api/v1/openapi.json veröffentlicht das API-Schema. Die generierten Artefakte für Postman, Bruno und TypeScript-Clients entstehen aus derselben Registry. So driften Docs, Tests und die tatsächlichen Routen nicht in drei getrennte Meinungen auseinander.

Lifecycle-Guards

Schreibende API-Calls folgen denselben Lifecycle-Regeln wie die App: sichere Updates, Statusübergänge, Idempotenz wo nötig, Soft-Delete oder Archivierung dort, wo die Historie bleiben muss. Eine API soll nicht die Hintertür für all das werden, was die UI zu Recht verweigert.

Wer sie nutzen sollte

Nutzen Sie die API, wenn ein anderes System einen Teil des Workflows besitzt oder verlässliche Synchronisation braucht. Nutzen Sie CSV und Importe, wenn es bei einem Mal bleibt. Nicht jede Tabelle verdient OAuth und einen eigenen Drehstuhl.