Pirmoji jūsų užklausa per penkias minutes

Nuo nulio iki per API sukurtos veikiančios sesijos, nepaliekant šio puslapio.

Prieš pradedant

  • Paskyra su mokamu planu: API nėra FREE plano dalis (visą žinyną galite naršyti ir nemokėdami).
  • Pristatymas jūsų darbo erdvėje: sesija, kurią ketinate sukurti, veda esamą pristatymą.

  1. Susikurkite kredencialą

    Savo darbo erdvėje atverkite Organizacija → API ir susikurkite kredencialą su content:write apimtimi. Paslaptis parodoma vieną kartą: išsaugokite ją.

    Gaukite savo API raktą

    Kredencialas priklauso organizacijai, o ne jūsų naudotojui: bet kuris administratorius gali jį atšaukti, o kiekvienas panaudojimas patenka į audito žurnalą. Prašykite tik tų apimčių, kurių reikia – results:read skaityti, content:write kurti ir vesti.

  2. Sukurkite ir atidarykite sesiją

    Su savo raktu X-API-Key antraštėje sukurkite sesiją esamam pristatymui ir ją atidarykite.

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

    Sesija gimsta būsenos DRAFT; ją atidarius sukuriamas jos join_code ir kambarys parengtas. Stebėkite X-RateLimit-* antraštes atsakyme: jos keliauja kiekviename atsakyme ir parodo, kiek užklausų biudžeto liko 60 sekundžių lange.

  3. Gaukite rezultatus

    Užregistruokite webhook įvykiui question.results.finalized ir gaukite pasirašytas suvestines savo serverio pusėje.

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

    Išsaugokite signing_secret, kurį grąžina registracija: jis parodomas vieną kartą ir būtent jis leidžia patikrinti kiekvieną pristatymą. Webhook vadove pateikiamas paruoštas tikrinimo kodas trimis kalbomis.

Jei kas nors atrodo ne taip

  • 401 – trūksta X-API-Key antraštės arba apimties: atsakymo turinyje laukas required_scope įvardija, kurios būtent.
  • 402 – jūsų planas API neapima: atsakymo turinyje laukas upgrade_to nurodo planą, kuris ją atrakina.
  • 429 – šio lango biudžetas išnaudotas: palaukite retry_after_seconds ir kartokite didėjančiais intervalais.

Kas toliau?

Naršykite visą žinyną, internete išbandykite kiekvieną galinį tašką ir prijunkite Zapier arba savo agentą per MCP.

API žinynas →