API-referanse

NexBasira sin offentlige API er REST + JSON, versjonert under /api/v1/public/*. Hvert endepunkt autentiseres via legitimasjonsparet cvp_pub:cvp_sec, er scope-begrenset og cursor-paginert der det returnerer en liste.

Base-URL

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

For self-hostede installasjoner, bytt verten med din egen. Stien er den samme.

Seksjoner

Autentisering — legitimasjonspar, signeringsskjema, scope-katalog
Paginering + idempotens — cursor-paginering + Idempotency-Key-header
Feil + ratebegrensninger — form på feilkonvolutt, X-RateLimit-*-headere
Økter — opprett, list, hent, avslutt, inviter
Bevis — list, hent, signert nedlastings-URL
Tavler — list per økt
Webhook-endepunkter — registrer / roter-hemmelighet / test-utsending
Merkevare — skrivebeskyttet på den offentlige API-en; endringer via SPA-en
Org — skrivebeskyttede org-metadata

OpenAPI-skjema

En filtrert OpenAPI 3.1-spesifikasjon (bare operasjonene merket public-api) serveres på https://app.nexbasira.com/api/public-schema/. Bruk den direkte med kodegeneratorer:

# 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-ene våre (@nexbasira/node + nexbasira for Python) er bygget oppå disse genererte typene og legger til håndskrevet ergonomi på toppen — typede feil, async-iterator-paginering, hjelpere for webhook-verifisering.

API-stabilitet

Den offentlige API-en følger semver-per-URL-navnerom. Brytende endringer leveres under et nytt prefiks (/api/v2/public/*) med minst 12 måneders overlapp før den forrige versjonen pensjoneres. Additive endringer (nye valgfrie felter, nye endepunkter, nye hendelsestyper) leveres på stedet; SDK-ene behandler ukjente felter som forover-kompatible.