API-referens

Det publika NexBasira-API:et är REST + JSON, versionerat under /api/v1/public/*. Varje endpoint autentiseras via ditt cvp_pub:cvp_sec-uppgiftspar, är scope-begränsat och cursor-paginerat där det returnerar en lista.

Bas-URL

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

För self-hostade installationer, byt ut värden mot din egen. Sökvägen är densamma.

Sektioner

Autentisering — uppgiftspar, signeringsschema, scope-katalog
Paginering + idempotens — cursor-paginering + Idempotency-Key-header
Fel + rate limits — form på felkuvertet, X-RateLimit-*-headers
Sessions — skapa, lista, hämta, avsluta, bjuda in
Evidence — lista, hämta, signerad nedladdnings-URL
Whiteboards — lista per session
Webhook-endpoints — registrera / rotera hemlighet / test-avfyra
Branding — skrivskyddat på det publika API:et; mutationer via SPA:n
Org — skrivskyddad org-metadata

OpenAPI-schema

En filtrerad OpenAPI 3.1-spec (endast de public-api-taggade operationerna) serveras på https://app.nexbasira.com/api/public-schema/. Använd den direkt med kodgeneratorer:

# 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

Våra SDK:er (@nexbasira/node + nexbasira för Python) är byggda ovanpå dessa genererade typer och lägger till handskriven ergonomi ovanpå — typade fel, async-iterator-paginering, hjälpfunktioner för webhook-verifiering.

API-stabilitet

Det publika API:et följer semver-per-URL-namnrymd. Brytande ändringar levereras under ett nytt prefix (/api/v2/public/*) med minst 12 månaders överlapp innan den föregående versionen tas ur bruk. Additiva ändringar (nya valfria fält, nya endpoints, nya händelsetyper) levereras på plats; SDK:erna behandlar okända fält som framåtkompatibla.