Teie esimene päring viie minutiga

Nullist API kaudu loodud otsesessioonini, sellelt lehelt lahkumata.

Enne alustamist

  • Konto tasulises plaanis: API ei kuulu FREE plaani (kogu teatmikku saab siiski tasuta sirvida).
  • Esitlus teie tööruumis: sessioon, mille kohe loote, käivitab olemasoleva esitluse.

  1. Looge oma mandaat

    Avage oma tööruumis Organisatsioon → API ja looge mandaat õigusega content:write. Saladust näidatakse üks kord: salvestage see.

    Hangi oma API võti

    Mandaat kuulub organisatsioonile, mitte teie kasutajale: iga administraator saab selle tühistada ja iga kasutuskord jõuab auditilogisse. Küsige ainult neid õigusi, mida vajate – results:read lugemiseks, content:write loomiseks ja juhtimiseks.

  2. Looge ja avage sessioon

    Pange oma võti päisesse X-API-Key, looge olemasoleva esitluse peal sessioon ja avage see.

    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_…"

    Sessioon sünnib olekus DRAFT; avamisel luuakse selle join_code ja ruum on valmis. Jälgige vastuse X-RateLimit-* päiseid: need liiguvad kaasa iga vastusega ja näitavad, kui palju päringueelarvet on 60-sekundilises aknas alles.

  3. Võtke tulemused vastu

    Registreerige webhook sündmusele question.results.finalized ja võtke allkirjastatud koondtulemused oma taustasüsteemis vastu.

    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"] }'

    Salvestage signing_secret, mille registreerimine tagastab: seda näidatakse üks kord ja just see võimaldab iga edastust kontrollida. Webhookide juhend annab kontrolli valmis kujul kolmes keeles, otse kleepimiseks.

Kui midagi tundub valesti

  • 401 – puudub päis X-API-Key või õigus: vastuse kehas on täpne nimi väljal required_scope.
  • 402 – teie plaan ei sisalda API-t: vastuse kehas on upgrade_to koos plaaniga, mis selle avab.
  • 429 – selle akna eelarve on otsas: oodake retry_after_seconds ja proovige kasvava ootega uuesti.

Mis edasi?

Sirvige täielikku teatmikku, proovige iga lõpp-punkti veebis ning ühendage Zapier või oma agent MCP kaudu.

API teatmik →