Referenční příručka API

Veřejné API NexBasira je REST + JSON, verzované pod /api/v1/public/*. Každý endpoint je autentizován přes vaši dvojici přihlašovacích údajů cvp_pub:cvp_sec, chráněný oprávněními a kurzorově stránkovaný tam, kde vrací seznam.

Základní URL

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

Pro self-hosting instalace nahraďte hostitele svým vlastním. Cesta je stejná.

Sekce

Autentizace — dvojice přihlašovacích údajů, schéma podpisu, katalog oprávnění
Stránkování + idempotence — kurzorové stránkování + hlavička Idempotency-Key
Chyby + limity průchodnosti — tvar chybové obálky, hlavičky X-RateLimit-*
Relace — vytvoření, výpis, získání, ukončení, pozvánka
Důkazy — výpis, získání, podepsaná URL pro stažení
Tabule — výpis na relaci
Webhook endpointy — registrace / rotace tajného klíče / testovací odeslání
Branding — pouze pro čtení ve veřejném API; mutace přes SPA
Organizace — metadata organizace pouze pro čtení

Schéma OpenAPI

Filtrovaná specifikace OpenAPI 3.1 (pouze operace označené tagem public-api) je poskytována na https://app.nexbasira.com/api/public-schema/. Použijte ji přímo s generátory kódu:

# 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

Naše SDK (@nexbasira/node + nexbasira pro Python) jsou postavená na těchto vygenerovaných typech a přidávají ručně psanou ergonomii — typované chyby, stránkování pomocí async iterátoru, pomocníky pro ověření webhooků.

Stabilita API

Veřejné API dodržuje semver podle URL namespace. Rušící změny se dodávají pod novým prefixem (/api/v2/public/*) s minimálně 12 měsíci překryvu, než je předchozí verze vyřazena. Aditivní změny (nová volitelná pole, nové endpointy, nové typy událostí) se dodávají na místě; SDK zacházejí s neznámými poli jako dopředně kompatibilními.