Az első hívása öt perc alatt

A nulláról egy API-val létrehozott, élő munkamenetig – anélkül, hogy elhagyná ezt az oldalt.

Mielőtt belekezd

  • Fizetős csomagú fiók: az API nem része a FREE csomagnak (a teljes referenciát fizetés nélkül is átnézheti).
  • Egy prezentáció a munkaterületén: a most létrehozandó munkamenet egy meglévő prezentációt futtat.

  1. Hozza létre a hitelesítő adatát

    A munkaterületén nyissa meg a Szervezet → API oldalt, és hozzon létre egy hitelesítő adatot a content:write jogosultsággal. A titkot csak egyszer mutatjuk meg: mentse el.

    Szerezze meg az API-kulcsát

    A hitelesítő adat a szervezethez tartozik, nem a felhasználójához: bármelyik rendszergazda visszavonhatja, és minden használata bekerül az auditnaplóba. Csak azt a jogosultságot kérje, amelyre szüksége van – results:read az olvasáshoz, content:write a létrehozáshoz és a vezérléshez.

  2. Hozzon létre és nyisson meg egy munkamenetet

    A kulcsával az X-API-Key fejlécben hozzon létre egy munkamenetet egy meglévő prezentációhoz, és nyissa meg.

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

    A munkamenet DRAFT állapotban születik; a megnyitás adja meg a join_code értékét, és ezzel a terem készen áll. Figyelje a válasz X-RateLimit-* fejléceit: minden válaszban ott utaznak, és megmutatják, mennyi kérés maradt a 60 másodperces ablakban.

  3. Fogadja az eredményeket

    Regisztráljon egy webhookot a question.results.finalized eseményre, és a háttérrendszerében aláírt összesítéseket kap.

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

    Mentse el a regisztrációkor kapott signing_secret értéket: csak egyszer mutatjuk meg, és ez teszi ellenőrizhetővé minden kézbesítést. A webhookok útmutatója három nyelven, beilleszthető formában adja meg az ellenőrzést.

Ha valami nem stimmel

  • 401 – hiányzik az X-API-Key fejléc vagy a jogosultság: a válasz törzse a required_scope mezőben nevezi meg a pontosat.
  • 402 – a csomagja nem tartalmazza az API-t: a válasz törzsében az upgrade_to mező mondja meg, melyik csomag oldja fel.
  • 429 – ebben az ablakban elfogyott a kerete: várjon retry_after_seconds ideig, és próbálja újra egyre ritkábban.

Mi legyen a következő lépés?

Nézze át a teljes referenciát, próbálja ki online az összes végpontot, és kösse be a Zapiert vagy az ügynökét MCP-n keresztül.

API-referencia →