Uw eerste aanroep in vijf minuten

Van niets naar een live sessie die via de API is aangemaakt, zonder deze pagina te verlaten.

Voordat u begint

  • Een account met een betaald abonnement: de API hoort niet bij FREE (de volledige referentie kunt u wel doorbladeren zonder te betalen).
  • Een presentatie in uw werkruimte: de sessie die u gaat aanmaken, draait een bestaande presentatie.
  1. Maak uw credential aan

    Ga in uw werkruimte naar Organisatie → API en maak een credential aan met de scope content:write. Het geheim wordt één keer getoond: bewaar het.

    Uw API-sleutel ophalen

    De credential is van de organisatie, niet van uw gebruiker: elke beheerder kan die intrekken en elk gebruik komt in de auditlog terecht. Vraag alleen de scopes aan die u nodig hebt – results:read om te lezen, content:write om aan te maken en te sturen.

  2. Maak een sessie aan en open die

    Maak met uw sleutel in de header X-API-Key een sessie aan op een bestaande presentatie en open die.

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

    De sessie ontstaat in DRAFT; bij het openen krijgt die haar join_code en staat de ruimte klaar. Let op de X-RateLimit-*-headers in het antwoord: die reizen met elk antwoord mee en vertellen u hoeveel verzoekbudget er nog over is binnen het venster van 60 seconden.

  3. Ontvang de resultaten

    Registreer een webhook voor question.results.finalized en ontvang ondertekende totalen in uw backend.

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

    Bewaar het signing_secret dat de registratie teruggeeft: het wordt één keer getoond en het is waarmee u elke bezorging verifieert. De handleiding over webhooks levert die verificatie kant-en-klaar in drie talen.

Als er iets niet klopt

  • 401 – de header X-API-Key of de scope ontbreekt: de body noemt de precieze scope in required_scope.
  • 402 – uw abonnement bevat de API niet: de body draagt upgrade_to met het abonnement dat die ontgrendelt.
  • 429 – het budget voor dit venster is op: wacht retry_after_seconds en probeer het opnieuw met backoff.

En daarna?

Blader door de volledige referentie, probeer elk endpoint online uit en koppel Zapier of uw agent via MCP.

API-referentie