Public API & OpenAPI: een contract, geen beleefde CSV-export

Sommige tenants leven de hele dag in ReVend OS. Andere hebben al een ERP, WMS, finance- of BI-systeem dat niet verdwijnt omdat er een mooiere knop is opgedoken. De publieke API bestaat voor die teams: gestructureerde toegang tot operationele records, zonder copy-pastediplomatie.

Wat de API dekt

Het live /v1-oppervlak bevat assets, orders, evidence, documents, companies, contacts, bedrijfsadressen, warehouses, catalogusdata, sellable assets, listings, auctions, events, webhooks en import jobs. Het is geen demo-endpoint in een blazer; het contract wordt gegenereerd, getest en via OpenAPI gepubliceerd.

Import jobs registreren momenteel alleen aanvragen. Automatische verwerking en bestandscontrole zijn niet beschikbaar; de API geeft processing_available: false terug. Gebruik de ondersteunde directe import-endpoints om gegevens te schrijven.

OpenAPI

/api/v1/openapi.json publiceert het API-schema. De gegenereerde Postman-, Bruno- en TypeScript-clientartefacten komen uit dezelfde registry. Zo drijven de documentatie, de tests en de echte routes niet uit elkaar tot drie aparte meningen.

Lifecycle-bewaking

API-writes volgen dezelfde lifecycle-ideeën als de app: veilige updates, statusovergangen, idempotentie waar het moet, soft delete of archivering waar de historiek moet blijven staan. Een API hoort geen zijdeur te worden voor dingen die de interface terecht weigert.

Wie hem zou moeten gebruiken

Gebruik de API wanneer een ander systeem een stuk van de workflow bezit of betrouwbare sync nodig heeft. Gebruik CSV en imports wanneer het eenmalig is. Niet elke spreadsheet verdient OAuth en een draaistoel.