Vaš prvi klic v petih minutah

Od nič do seje v živo, ustvarjene prek API-ja, ne da bi zapustili to stran.

Preden začnete

  • Račun v plačljivem paketu: API ni del paketa FREE (celotno referenco lahko kljub temu brskate brezplačno).
  • Predstavitev v vašem prostoru: seja, ki jo boste ustvarili, izvaja obstoječo predstavitev.
  1. Ustvarite svojo poverilnico

    V svojem prostoru odprite Organizacija → API in ustvarite poverilnico z obsegom content:write. Skrivnost je prikazana enkrat: shranite jo.

    Pridobite svoj ključ API

    Poverilnica pripada organizaciji, ne vašemu uporabniku: prekliče jo lahko vsak skrbnik, vsaka uporaba pa se zapiše v revizijski dnevnik. Zahtevajte samo obsege, ki jih potrebujete – results:read za branje, content:write za ustvarjanje in vodenje.

  2. Ustvarite in odprite sejo

    S svojim ključem v glavi X-API-Key ustvarite sejo na obstoječi predstavitvi in jo odprite.

    curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/sessions \
      -H "X-API-Key: vz_live_…" \
      -d '{ "presentation_id": "prs_8f3k2" }'
    
    curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/sessions/ses_71xw9/open \
      -H "X-API-Key: vz_live_…"

    Seja se rodi v stanju DRAFT; ko jo odprete, dobi svojo kodo join_code in soba je pripravljena. Opazujte glave X-RateLimit-* v odgovoru: potujejo v vsakem odzivu in povedo, koliko proračuna za zahteve ostane v 60-sekundnem oknu.

  3. Prejmite rezultate

    Registrirajte webhook za question.results.finalized in v svoje zaledje prejemajte podpisane skupke.

    curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/webhooks \
      -H "X-API-Key: vz_live_…" \
      -d '{ "url": "https://example.com/hooks/votinova",
            "event_types": ["question.results.finalized"] }'

    Shranite skrivnost signing_secret, ki jo vrne registracija: prikazana je enkrat in prav z njo preverjate vsako dostavo. Vodnik za webhooke prinaša preverjanje, pripravljeno za prilepitev, v treh jezikih.

Če kaj ni videti prav

  • 401 – manjka glava X-API-Key ali obseg: telo odgovora natančno navede manjkajočega v polju required_scope.
  • 402 – vaš paket ne vključuje API-ja: telo odgovora nosi upgrade_to s paketom, ki ga odklene.
  • 429 – proračun za to okno je porabljen: počakajte retry_after_seconds in poskusite znova z zamikom.

Kaj sledi?

Prebrskajte celotno referenco, na spletu preizkusite vsako končno točko in prek MCP povežite Zapier ali svojega agenta.

Referenca API