Skip to main content

​
Base URL

Todas as requisições públicas da EZ API usam a base URL: 
https://api.ezapi.com.br

​
Estrutura das rotas

Depois de criar a instância, quase toda a API segue este padrão: 
/instances/{instanceId}/token/{instanceToken}/{acao}
Os únicos endpoints públicos fora desse padrão são as rotas de criação de instância e os materiais de documentação.

​
Autenticação

A autenticação combina dois elementos:
  1. Header Client-Token em todas as rotas públicas.
  2. instanceToken na própria URL para rotas específicas da instância.
Consulte a página de autenticação para detalhes e uso no playground.

​
Como a collection foi mapeada para a documentação

CollectionGrupo final na documentaçãoObservação
InstanceInstânciaInclui criação, conexão, dispositivo, perfil e AntiBan.
MessagesMensagensInclui envios, reações, interativos, enquete e diagnóstico.
PrivacyPrivacidadeConfigurações de visibilidade e mensagens temporárias.
ContactsContatosListagem, verificação de número, foto e bloqueio.
ChatsConversasMetadados, alteração de estado e expiração por chat.
GroupsGruposCriação, metadados, convite, participantes e permissões.
StatusStatusPublicação de texto e imagem no status do WhatsApp.
Message queueFila de mensagensConsulta e limpeza da fila de envio.
WhatsApp BusinessWhatsApp BusinessCatálogo e produtos publicados na collection.
WebhooksWebhooksURLs de callback e payloads reais dos eventos.
🔍 SystemNão documentadoRotas internas de health e docs.
🔐 Admin — AccountsNão documentadoRotas administrativas/backoffice.
🔑 Admin — API KeysNão documentadoRotas administrativas/backoffice.
CommunitiesNão documentadoAs rotas dedicadas de comunidades retornam 501 no build atual.

​
Divergências resolvidas pela implementação atual

  • A collection pública tem um item Rejeitar participantes apontando para /approve-participant. A navegação final manteve apenas a rota publicada que realmente aparece na collection.
  • Os exemplos antigos de privacy/read-receipts e privacy/messages-duration usam query string ?value=. Na EZ API atual, o valor deve ser enviado no corpo JSON, que é o formato adotado no playground e nos exemplos finais.
  • O grupo Communities foi removido porque os endpoints específicos dessa área não estão suportados no build real da EZ API.

​
Formatos importantes

  • Telefones: sempre no formato internacional, sem +, espaços ou pontuação. Exemplo: 5511999999999.
  • Identificador de grupo: normalmente no formato documental 120363123456789-group, embora a API também normalize JIDs quando necessário.
  • URLs de webhook: obrigatoriamente HTTPS.