La teva primera crida en cinc minuts

De zero a una sessió en directe creada per API, sense sortir d'aquesta pàgina.

Abans de començar

  • Un compte amb un pla de pagament: l'API no forma part del pla FREE (tot i així pots consultar la referència sencera sense pagar).
  • Una presentació al teu espai de treball: la sessió que estàs a punt de crear executa una presentació que ja existeix.

  1. Crea la teva credencial

    Al teu espai de treball, obre Organització → API i crea una credencial amb l'àmbit content:write. El secret es mostra un sol cop: desa'l.

    Aconsegueix la teva clau d'API

    La credencial és de l'organització, no del teu usuari: qualsevol administrador la pot revocar i cada ús queda al registre d'auditoria. Demana només els àmbits que necessitis: results:read per llegir i content:write per crear i conduir.

  2. Crea i obre una sessió

    Amb la teva clau a la capçalera X-API-Key, crea una sessió sobre una presentació que ja existeixi i obre-la.

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

    La sessió neix en estat DRAFT; en obrir-la es genera el seu join_code i la sala queda a punt. Fixa't en les capçaleres X-RateLimit-* de la resposta: viatgen a cada resposta i et diuen quant pressupost de peticions et queda dins la finestra de 60 segons.

  3. Rep els resultats

    Registra un webhook per a question.results.finalized i rep els agregats signats al teu 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"] }'

    Desa el signing_secret que et torna el registre: es mostra un sol cop i és el que et permet verificar cada lliurament. La guia de webhooks porta la verificació a punt per enganxar en tres llenguatges.

Si alguna cosa no rutlla

  • 401 — falta la capçalera X-API-Key o l'àmbit: el cos et diu exactament quin, a required_scope.
  • 402 — el teu pla no inclou l'API: el cos porta upgrade_to amb el pla que la desbloqueja.
  • 429 — has esgotat el pressupost d'aquesta finestra: espera retry_after_seconds i torna-ho a provar amb espera creixent.

I ara què?

Consulta la referència sencera, prova en línia tots els extrems i connecta-hi Zapier o el teu agent per MCP.

Referència de l'API →