Ваш перший виклик за пʼять хвилин

Від нуля до сесії наживо, створеної через API, не полишаючи цієї сторінки.

Перш ніж почати

  • Обліковий запис на платному плані: API не входить до FREE (проте весь довідник можна переглядати безкоштовно).
  • Презентація у Вашому просторі: сесія, яку Ви створюєте, запускає наявну презентацію.

  1. Створіть свої облікові дані

    У своєму просторі відкрийте розділ Організація → API і створіть облікові дані з областю дії content:write. Секрет показується лише раз: збережіть його.

    Отримати ключ API

    Облікові дані належать організації, а не Вашому користувачеві: будь-який адміністратор може їх відкликати, і кожне використання потрапляє до журналу аудиту. Запитуйте лише потрібні області дії — results:read, щоб читати, і content:write, щоб створювати та керувати.

  2. Створіть і відкрийте сесію

    Із Вашим ключем у заголовку X-API-Key створіть сесію на наявній презентації та відкрийте її.

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

    Сесія народжується у стані DRAFT; відкриття створює її join_code, і зала готова. Стежте за заголовками X-RateLimit-* у відповіді: вони приходять із кожною відповіддю й показують, скільки бюджету запитів лишилося у вікні на 60 секунд.

  3. Отримуйте результати

    Зареєструйте webhook на question.results.finalized і отримуйте підписані зведені дані у своєму бекенді.

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

    Збережіть signing_secret, який повертає реєстрація: він показується лише раз і саме він дає змогу перевіряти кожну доставку. Посібник із webhooks містить готову перевірку, яку можна вставити трьома мовами програмування.

Якщо щось пішло не так

  • 401 — бракує заголовка X-API-Key або області дії: тіло відповіді називає точну в полі required_scope.
  • 402 — Ваш план не включає API: тіло відповіді містить upgrade_to з планом, який його відкриває.
  • 429 — бюджет цього вікна вичерпано: зачекайте retry_after_seconds і повторіть із відкладанням.

Що далі?

Перегляньте повний довідник, спробуйте кожну кінцеву точку онлайн і підключіть Zapier чи свого агента через MCP.

Довідник API →