LIVE · AUDIT-KÆDE · EU-HOSTET
SYSTEM · 99,99 % OPPETID
v 1.0 ↗ FREMSTILLET I EU

API-reference

Det offentlige NexBasira-API er REST + JSON, versioneret under /api/v1/public/*. Hvert endpoint autentificeres via dit cvp_pub:cvp_sec-legitimationspar, er scope-gated og cursor-pagineret, hvor det returnerer en liste.

Base-URL

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

For self-hostede installationer skal du udskifte hosten med din egen. Stien er den samme.

Sektioner

OpenAPI-skema

En filtreret OpenAPI 3.1-spec (kun operationerne tagget public-api) serveres på https://app.nexbasira.com/api/public-schema/. Brug 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

Vores SDK'er (@nexbasira/node + nexbasira til Python) er bygget oven på disse genererede typer og lægger håndskrevet ergonomi ovenpå — typede fejl, async-iterator-paginering, webhook-verificerings-hjælpere.

API-stabilitet

Det offentlige API følger semver pr. URL-namespace. Brydende ændringer udgives under et nyt præfiks (/api/v2/public/*) med mindst 12 måneders overlap, før den forrige version udfases. Additive ændringer (nye valgfrie felter, nye endpoints, nye event-typer) udgives på stedet; SDK'erne behandler ukendte felter som fremadkompatible.