Ontwikkelaar

API-referentie

Alles wat u nodig hebt om met NexusKit te integreren. Authenticatie, endpoints, foutafhandeling en rate limits — allemaal op één plek.

Basis-URL

Alle API-verzoeken gebruiken de volgende basis-URL:

$https://api.nexus-kit.com

Alle endpoints zijn geversioneerd onder /v1/. Publieke endpoints gebruiken /v1/public/.

Authenticatie

NexusKit gebruikt Bearer token-authenticatie. Neem uw API-sleutel op in de Authorization-header:

Authorization: Bearer nk_live_abc123def456...

API-sleutelformaten

nk_live_Productiesleutels — gebruiken in live-omgevingen

nk_test_Testsleutels — gebruiken tijdens ontwikkeling en staging

API-sleutels zijn per module scoped. U kunt read-only- of read-write-sleutels aanmaken in het Dashboard onder Developers → API Keys.

Veelgebruikte headers

Neem deze headers op bij elk API-verzoek:

Header	Verplicht	Beschrijving
Authorization	Ja	Bearer token — uw API-sleutel voorafgegaan door Bearer
X-Tenant-Id	Nee	Overschrijf de Tenant-context (geavanceerd — standaard de eigenaar-Tenant van de sleutel)
Content-Type	Voor POST/PATCH	Stel in op application/json voor JSON request-bodies

Foutresponses

Alle API-responses volgen een consistent envelope-formaat. Fouten bevatten een machineleesbare code en een leesbaar bericht:

{
  "data": null,
  "meta": {},
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": {
      "field": "email",
      "reason": "missing_required"
    }
  }
}

HTTP-status	Foutcode	Beschrijving
400	VALIDATION_ERROR	Request-body heeft de validatie niet doorstaan
401	UNAUTHORIZED	Ontbrekende of ongeldige API-sleutel
403	FORBIDDEN	API-sleutel mist de vereiste scope
404	NOT_FOUND	Resource bestaat niet
429	RATE_LIMITED	Te veel verzoeken — vertraag
500	INTERNAL_ERROR	Er ging iets mis aan onze kant

Snelheidsbeperking

Om NexusKit snel en eerlijk te houden voor iedereen, worden alle API-verzoeken snelheidsbeperkt:

120verzoeken per minuut per IP per Tenant

Wanneer u de limiet bereikt, ontvangt u een 429 Too Many Requests-response. Wacht even en probeer het opnieuw. De response bevat Retry-After-headers met het aantal seconden dat u moet wachten.

Contact

Vang leads op van websiteformulieren via de API. Inzendingen komen terecht in uw Dashboard met e-mailmeldingen.

Methode	Pad	Auth	Scope	Beschrijving
GET	/v1/contact/forms	Bearer	contact:read	Lijst alle formulieren voor uw Tenant
POST	/v1/contact/forms	Bearer	contact:write	Maak een nieuw contactformulier aan
GET	/v1/contact/forms/:id/submissions	Bearer	contact:read	Lijst inzendingen voor een formulier
PATCH	/v1/contact/submissions/:id	Bearer	contact:write	Werk status of notities van een inzending bij
GET	/v1/contact/export.csv	Bearer	contact:read	Exporteer inzendingen als CSV
POST	/v1/public/contact/forms/:id/submissions	None	—	Publiek — dien een formulier in vanaf uw site

Boekingen

Agendaboekingen met services, beschikbaarheidsslots en afsprakenbeheer.

Methode	Pad	Auth	Scope	Beschrijving
GET	/v1/booking/services	Bearer	booking:read	Lijst alle boekingsservices
POST	/v1/booking/services	Bearer	booking:write	Maak een nieuwe boekingsservice aan
POST	/v1/booking/availability	Bearer	booking:write	Vraag beschikbare tijdslots op
GET	/v1/booking/bookings	Bearer	booking:read	Lijst alle boekingen
GET	/v1/booking/export.csv	Bearer	booking:read	Exporteer boekingen als CSV
GET	/v1/public/booking/services	None	—	Publiek — lijst services om in te sluiten
GET	/v1/public/booking/services/:id/slots	None	—	Publiek — haal beschikbare slots op voor een service
POST	/v1/public/booking/bookings	None	—	Publiek — maak een boeking aan

Links & QR

Korte links en afdrukbare QR-codes met privacyveilige geaggregeerde analyses.

Methode	Pad	Auth	Scope	Beschrijving
GET	/v1/qr/links	Bearer	qr:read	Lijst alle korte links
POST	/v1/qr/links	Bearer	qr:write	Maak een nieuwe korte link of QR-code aan
GET	/v1/qr/export.csv	Bearer	qr:read	Exporteer links en analyses als CSV
GET	/v1/public/qr/r/:slug	None	—	Publiek — verwijs korte link door en registreer scan
GET	/v1/public/qr/:id.svg	None	—	Publiek — serveer QR-code als SVG

Onboarding

Meerstaps-onboarding-flows met voortgangsregistratie en afronding-webhooks.

Methode	Pad	Auth	Scope	Beschrijving
GET	/v1/onboarding/flows	Bearer	onboarding:read	Lijst alle onboarding-flows
POST	/v1/onboarding/flows	Bearer	onboarding:write	Maak een nieuwe onboarding-flow aan
GET	/v1/onboarding/sessions	Bearer	onboarding:read	Lijst onboarding-sessies
GET	/v1/onboarding/export.csv	Bearer	onboarding:read	Exporteer sessies als CSV
POST	/v1/public/onboarding/sessions	None	—	Publiek — start een nieuwe sessie
PATCH	/v1/public/onboarding/sessions/:id	None	—	Publiek — laat sessie doorgaan naar volgende stap

Facturen

Digitale en afdrukbare facturen en bonnen met e-mailbezorging.

Methode	Pad	Auth	Scope	Beschrijving
GET	/v1/invoice/invoices	Bearer	invoice:read	Lijst alle facturen
POST	/v1/invoice/invoices	Bearer	invoice:write	Maak een nieuwe factuur aan
GET	/v1/invoice/invoices/:id/print	Bearer	invoice:read	Render factuur als afdrukbare PDF
GET	/v1/invoice/export.csv	Bearer	invoice:read	Exporteer facturen als CSV

Hulp nodig?

Sluit u aan bij onze community of raadpleeg de FAQ in de zijbalk.

Gratis account aanmaken Snelstart