REST API

Documentação da API v1

Integre sua aplicação em minutos. Todas as rotas exigem uma API Key enviada comoAuthorization: Bearer.

Autenticação

Gere sua chave em Configurações → API Keys. A chave é mostrada uma única vez — armazene com segurança.

Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Rate limiting

Cada API Key tem um limite de requisições por minuto (padrão 60/min). As respostas incluem os headers:

X-RateLimit-Limit — teto por minuto
X-RateLimit-Remaining — requisições restantes na janela atual
X-RateLimit-Reset — segundos até resetar

Quando excedido, retorna HTTP 429 com header Retry-After.

GET

/api/public/v1/me

Identidade

Retorna o perfil, papel e escopos vinculados à API Key.

curl -X GET "https://seu-dominio.com/api/public/v1/me" \
  -H "Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json"

GET

/api/public/v1/plans

Listar planos

Retorna todos os planos ativos visíveis para você.

curl -X GET "https://seu-dominio.com/api/public/v1/plans" \
  -H "Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json"

GET

/api/public/v1/subscriptions

Listar assinaturas

Suas assinaturas ativas (ou de todos os clientes se for admin/revendedor).

curl -X GET "https://seu-dominio.com/api/public/v1/subscriptions" \
  -H "Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json"

GET

/api/public/v1/instances

Listar instâncias

Instâncias Evolution API vinculadas a você (até 200).

curl -X GET "https://seu-dominio.com/api/public/v1/instances" \
  -H "Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json"

GET

/api/public/v1/instances/:id

Detalhes de uma instância

Retorna os dados de uma instância específica.

curl -X GET "https://seu-dominio.com/api/public/v1/instances/INSTANCE_ID" \
  -H "Authorization: Bearer evo_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json"

Códigos de erro

401 unauthorized

API Key ausente, inválida ou revogada.

403 insufficient_scope

Chave não tem escopo necessário (read/write).

429 rate_limited

Limite por minuto excedido. Aguarde e tente novamente.

500 db_error

Erro interno ao consultar o banco.