For AI agents: fetch the complete documentation index at /llms.txt, the full documentation corpus at /llms-full.txt, the agent skill at /skill.md, or this page as Markdown at /nl/docs/web/api.md (or send Accept: text/markdown).

Publieke API, sleutels en webhooks

Het geversioneerde REST-oppervlak waarop je klanten bouwen.

Vraag over deze handleiding

Voordat je begint

Open uw gedownloade supastack-project in Visual Studio Code met behulp van Bestand → Map openen en kies vervolgens Terminal → Nieuwe terminal. De root van de repository is de map met package.json, apps en pakketten. Voer daar de onderstaande opdracht uit en laat de terminal open. Als een opdracht niet wordt herkend, voltooi dan de installatiehandleiding van het hulpprogramma voordat u verdergaat.

Lees eerst de platformtutorial. Een server is het app-proces dat browser- of telefoonverzoeken beantwoordt. Web leest apps/web/.env.local, Expo leest apps/mobile/.env.local en opdrachten voor databasemigratie lezen root .env. De demonstratie zonder database/dashboard staat los van echte/auth-accounts, waarvoor Postgres moet worden gemigreerd. Voor een telefoon- of desktop-afrekening is een afzonderlijk draaiende web-backend nodig.

corepack pnpm --filter @supastack/web dev

Setup en configuratie

packages/api definieert het geversioneerde contract: zod-schemas voor elke request en response, de error-envelope en het OpenAPI-document geserveerd op /api/v1/openapi en gerenderd op /api/docs. Workspace-API-sleutels worden aangemaakt in Instellingen → Developers; de plaintext wordt eenmalig getoond, daarna blijft alleen de gehashte sleutel bestaan.

Sleutels zijn geprefixed (sk_<env>_…), gescoped (standaard read) en resolven bij elke request naar een workspace. Uitgaande webhook-subscriptions worden beheerd op hetzelfde Developers-oppervlak.

GET  /api/v1/workspaces/current
GET  /api/v1/entitlements
GET  /api/v1/models/requirements
POST /api/v1/ai-tasks
GET  /api/v1/openapi           # machine-readable spec
GET  /api/docs                 # rendered reference

Authorization: Bearer sk_live_…

Implementatieworkflow

Authenticeer met de Bearer-key; de server resolvet de workspace vanuit de sleutel, nooit vanuit een door de client opgegeven id. Houd response-vormen geversioneerd — additive wijzigingen binnen v1, breaking changes achter een nieuwe versie.

Voor uitgaande webhooks subscribe je een endpoint-URL op de eventcatalogus; leveringen worden ondertekend en gelogd zodat consumenten kunnen verifiëren en opnieuw afspelen. Gebruik webhook-events.ts voor de catalogus en webhook-delivery.ts voor de pogingen.

Verificatie en probleemoplossing

Verifieer dat een ingetrokken sleutel 401 retourneert, dat een sleutel met onvoldoende scope wordt geweigerd en dat het OpenAPI-document parseert. Test voor webhooks de signature-verificatie, herlevering na falen en dat event-payloads nooit provider-secrets meedragen.