Integrações · API REST

API REST documentada, versionada, idempotente

Cada endpoint segue convenção Stripe/Twilio: paginação cursor, idempotency key obrigatória em POST, erros estruturados.

Autenticação por Bearer token

integrations.api.sections.authText

Endpoints principais

Conversations, messages, departments, categories, macros, hold reasons, SLA configs, message templates, KB, FAQ, tags, operator status, webhook endpoints, audit log.

Versionamento

Rota /v1/ fixa. v2 quando vier coexiste com v1 por 12 meses mínimo, com header Sunset (RFC 8594) começando 6 meses antes.

Exemplo: criar conversa

bash
curl https://api.vaidesk.com/v1/conversations \
  -X POST \
  -H "Authorization: Bearer vd_live_a3b1f7e2_4f8a9c2d..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8e3a..." \
  -d '{
    "external_user_id": "user_123",
    "subject": "Question about plan",
    "initiated_by_side": "end_user"
  }'

Pronto para integrar atendimento robusto no seu produto?

Conte sobre seu caso. Retornamos em até um dia útil.