Referință API

API-ul public NexBasira este REST + JSON, versionat sub /api/v1/public/*. Fiecare endpoint este autentificat prin perechea dvs. de credențiale cvp_pub:cvp_sec, restrâns la scope-uri și paginat prin cursor acolo unde returnează o listă.

URL de bază

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

Pentru instalări self-hosted, înlocuiți host-ul cu al dvs. Calea rămâne aceeași.

Secțiuni

Autentificare — pereche de credențiale, schemă de semnare, catalog de scope-uri
Paginare + idempotență — paginare prin cursor + antet Idempotency-Key
Erori + rate limits — forma plicului de eroare, antete X-RateLimit-*
Sesiuni — creare, listare, obținere, încheiere, invitare
Probe — listare, obținere, URL de descărcare semnat
Tablouri — listare per sesiune
Endpoint-uri webhook — înregistrare / rotire-secret / test-fire
Branding — doar-citire pe API-ul public; modificări prin SPA
Organizație — metadate de organizație doar-citire

Schemă OpenAPI

O specificație OpenAPI 3.1 filtrată (doar operațiile etichetate public-api) este servită la https://app.nexbasira.com/api/public-schema/. Folosiți-o direct cu generatoare de cod:

# 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

SDK-urile noastre (@nexbasira/node + nexbasira pentru Python) sunt construite peste aceste tipuri generate și adaugă deasupra ergonomie scrisă manual — erori tipizate, paginare cu async-iterator, funcții ajutătoare de verificare a webhook-urilor.

Stabilitatea API

API-ul public urmează semver-pe-namespace-de-URL. Modificările incompatibile sunt livrate sub un prefix nou (/api/v2/public/*) cu cel puțin 12 luni de suprapunere înainte ca versiunea anterioară să fie retrasă. Modificările aditive (câmpuri opționale noi, endpoint-uri noi, tipuri de evenimente noi) sunt livrate în loc; SDK-urile tratează câmpurile necunoscute ca fiind compatibile înainte.