API-referentie

De publieke NexBasira-API is REST + JSON, geversioneerd onder /api/v1/public/*. Elk endpoint wordt geauthenticeerd via uw cvp_pub:cvp_sec-credentialpaar, is scope-afgeschermd en cursor-gepagineerd waar het een lijst retourneert.

Base-URL

https://app.nexbasira.com/api/v1/public

Vervang bij self-hosted installaties de host door uw eigen. Het pad blijft gelijk.

Secties

Authenticatie — credentialpaar, ondertekeningsschema, scope-catalogus
Paginatie + idempotentie — cursor-paginatie + Idempotency-Key-header
Fouten + rate limits — vorm van de foutenvelope, X-RateLimit-*-headers
Sessies — aanmaken, lijst, ophalen, beëindigen, uitnodigen
Bewijs — lijst, ophalen, ondertekende download-URL
Whiteboards — lijst per sessie
Webhook-endpoints — registreren / geheim roteren / testverzending
Branding — alleen-lezen op de publieke API; mutaties via de SPA
Org — alleen-lezen org-metadata

OpenAPI-schema

Een gefilterde OpenAPI 3.1-spec (alleen de operaties met de tag public-api) wordt geserveerd op https://app.nexbasira.com/api/public-schema/. Gebruik hem direct met codegeneratoren:

# Node typed types
npx openapi-typescript https://app.nexbasira.com/api/public-schema/ -o src/nb-types.ts

# Python typed models
datamodel-codegen \
  --url https://app.nexbasira.com/api/public-schema/ \
  --input-file-type openapi \
  --output-model-type pydantic_v2.BaseModel \
  --output cvp_models.py

Onze SDK's (@nexbasira/node + nexbasira voor Python) zijn bovenop deze gegenereerde types gebouwd en voegen daar met de hand geschreven ergonomie aan toe — getypeerde fouten, async-iterator-paginatie, webhook-verify-helpers.

API-stabiliteit

De publieke API volgt semver-per-URL-namespace. Breaking changes verschijnen onder een nieuwe prefix (/api/v2/public/*) met minstens 12 maanden overlap voordat de vorige versie wordt uitgefaseerd. Additieve wijzigingen (nieuwe optionele velden, nieuwe endpoints, nieuwe event-types) verschijnen in-place; de SDK's behandelen onbekende velden als voorwaartscompatibel.