Jūsu pirmais izsaukums piecās minūtēs

No nulles līdz caur API izveidotai darbojošai sesijai, nepametot šo lapu.

Pirms sākat

  • Konts ar maksas plānu: API nav daļa no FREE (visu rokasgrāmatu varat pārlūkot arī nemaksājot).
  • Prezentācija jūsu darbvietā: sesija, kuru gatavojaties izveidot, vada esošu prezentāciju.

  1. Izveidojiet akreditācijas datus

    Savā darbvietā atveriet Organizācija → API un izveidojiet akreditācijas datus ar content:write tvērumu. Noslēpums tiek parādīts vienu reizi: saglabājiet to.

    Iegūstiet savu API atslēgu

    Akreditācijas dati pieder organizācijai, nevis jūsu lietotājam: jebkurš administrators var tos atsaukt, un katrs lietojums nonāk audita žurnālā. Pieprasiet tikai tos tvērumus, kas nepieciešami – results:read lasīšanai, content:write veidošanai un vadīšanai.

  2. Izveidojiet un atveriet sesiju

    Ar savu atslēgu X-API-Key galvenē izveidojiet sesiju esošai prezentācijai un atveriet to.

    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 piedzimst statusā DRAFT; to atverot tiek izveidots tās join_code un istaba ir gatava. Vērojiet X-RateLimit-* galvenes atbildē: tās ceļo katrā atbildē un rāda, cik pieprasījumu budžeta atlicis 60 sekunžu logā.

  3. Saņemiet rezultātus

    Reģistrējiet webhook notikumam question.results.finalized un saņemiet parakstītus kopsavilkumus savā serverī.

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

    Saglabājiet signing_secret, ko atgriež reģistrācija: tas tiek parādīts vienu reizi, un tieši tas ļauj pārbaudīt katru piegādi. Webhook ceļvedī ir gatavs pārbaudes kods trīs valodās.

Ja kaut kas šķiet nepareizi

  • 401 – trūkst X-API-Key galvenes vai tvēruma: atbildes saturā lauks required_scope nosauc, kura tieši.
  • 402 – jūsu plāns API neietver: atbildes saturā lauks upgrade_to norāda plānu, kas to atslēdz.
  • 429 – šī loga budžets iztērēts: pagaidiet retry_after_seconds un mēģiniet vēlreiz pieaugošos intervālos.

Kas tālāk?

Pārlūkojiet visu rokasgrāmatu, tiešsaistē izmēģiniet katru galapunktu un pievienojiet Zapier vai savu aģentu caur MCP.

API rokasgrāmata →