Introdução à API

Base URL

Todas as requisições públicas da EZ API usam a base URL:

https://api.ezapi.com.br

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.

A autenticação combina dois elementos:

Consulte a página de autenticação para detalhes e uso no playground.

Collection	Grupo final na documentação	Observação
`Instance`	`Instância`	Inclui criação, conexão, dispositivo, perfil e AntiBan.
`Messages`	`Mensagens`	Inclui envios, reações, interativos, enquete e diagnóstico.
`Privacy`	`Privacidade`	Configurações de visibilidade e mensagens temporárias.
`Contacts`	`Contatos`	Listagem, verificação de número, foto e bloqueio.
`Chats`	`Conversas`	Metadados, alteração de estado e expiração por chat.
`Groups`	`Grupos`	Criação, metadados, convite, participantes e permissões.
`Status`	`Status`	Publicação de texto e imagem no status do WhatsApp.
`Message queue`	`Fila de mensagens`	Consulta e limpeza da fila de envio.
`WhatsApp Business`	`WhatsApp Business`	Catálogo e produtos publicados na collection.
`Webhooks`	`Webhooks`	URLs de callback e payloads reais dos eventos.
`🔍 System`	Não documentado	Rotas internas de health e docs.
`🔐 Admin — Accounts`	Não documentado	Rotas administrativas/backoffice.
`🔑 Admin — API Keys`	Não documentado	Rotas administrativas/backoffice.
`Communities`	Não documentado	As rotas dedicadas de comunidades retornam `501` no build 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.

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.