API-Referenz

Die öffentliche NexBasira-API ist REST + JSON, versioniert unter /api/v1/public/*. Jeder Endpoint wird über Ihr cvp_pub:cvp_sec-Credential-Paar authentifiziert, ist scope-gebunden und cursor-paginiert, wo er eine Liste zurückgibt.

Basis-URL

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

Für Self-Hosted-Installationen tauschen Sie den Host durch Ihren eigenen. Der Pfad ist derselbe.

Abschnitte

Authentifizierung — Credential-Paar, Signierschema, Scope-Katalog
Paginierung + Idempotenz — Cursor-Paginierung + Idempotency-Key-Header
Fehler + Rate-Limits — Fehler-Envelope-Form, X-RateLimit-*-Header
Sessions — erstellen, auflisten, abrufen, beenden, einladen
Evidence — auflisten, abrufen, signierte Download-URL
Whiteboards — pro Sitzung auflisten
Webhook-Endpoints — registrieren / Secret rotieren / Test fire
Branding — schreibgeschützt in der öffentlichen API; Mutationen über die SPA
Org — schreibgeschützte Org-Metadaten

OpenAPI-Schema

Eine gefilterte OpenAPI-3.1-Spec (nur die public-api-getaggten Operationen) wird unter https://app.nexbasira.com/api/public-schema/ bereitgestellt. Nutzen Sie sie direkt mit Code-Generatoren:

# 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

Unsere SDKs (@nexbasira/node + nexbasira für Python) sind auf diesen generierten Typen aufgebaut und ergänzen handgeschriebene Ergonomie obendrauf — typisierte Fehler, Async-Iterator-Paginierung, Webhook-Verify-Helper.

API-Stabilität

Die öffentliche API folgt Semver-per-URL-Namespace. Breaking Changes erscheinen unter einem neuen Präfix (/api/v2/public/*) mit mindestens 12 Monaten Überlappung, bevor die vorherige Version zurückgezogen wird. Additive Änderungen (neue optionale Felder, neue Endpoints, neue Event-Typen) erscheinen an Ort und Stelle; die SDKs behandeln unbekannte Felder als vorwärtskompatibel.