Ditt første kall på fem minutter

Fra null til en økt som kjører live, opprettet via API-et – uten å forlate denne siden.

Før du begynner

  • En konto på et abonnement du betaler for: API-et er ikke med i FREE (du kan likevel bla gjennom hele referansen uten å betale).
  • En presentasjon i arbeidsområdet ditt: økten du skal opprette, kjører en presentasjon som allerede finnes.

  1. Lag tilgangsnøkkelen din

    I arbeidsområdet ditt åpner du Organisasjon → API og lager en tilgangsnøkkel med tillatelsen content:write. Hemmeligheten vises bare én gang: ta vare på den.

    Hent API-nøkkelen din

    Tilgangsnøkkelen hører til organisasjonen, ikke til brukeren din: enhver administrator kan trekke den tilbake, og hver bruk havner i revisjonsloggen. Be bare om tillatelsene du trenger – results:read for å lese, content:write for å opprette og styre.

  2. Opprett og åpne en økt

    Med nøkkelen din i X-API-Key-headeren oppretter du en økt på en presentasjon du allerede har, og åpner den.

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

    Økten fødes i DRAFT; når du åpner den, lages join_code-en, og rommet er klart. Følg med på X-RateLimit-*-headerne i svaret: de følger med hver gang og forteller hvor mye av forespørselsbudsjettet som er igjen i vinduet på 60 sekunder.

  3. Ta imot resultatene

    Registrer en webhook for question.results.finalized, og få signerte aggregater inn i backend-en din.

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

    Ta vare på signing_secret som registreringen gir deg: den vises bare én gang, og det er den som lar deg verifisere hver levering. Veiledningen for webhooks har verifiseringen klar til å limes inn i tre programmeringsspråk.

Hvis noe ser feil ut

  • 401 – X-API-Key-headeren eller tillatelsen mangler: kroppen navngir nøyaktig hvilken i required_scope.
  • 402 – abonnementet ditt inkluderer ikke API-et: kroppen bærer upgrade_to med abonnementet som låser det opp.
  • 429 – budsjettet for dette vinduet er brukt opp: vent retry_after_seconds og prøv igjen med økende ventetid.

Hva nå?

Bla gjennom hele referansen, prøv alle endepunktene på nett, og koble til Zapier eller agenten din over MCP.

API-referanse →