Z-API Compatibilidade

Migre da Z-API para o Omni Z-API sem quebrar suas integrações

​

O que é a versão Z-API Compatibilidade?

A versão Z-API Compatibilidade foi criada para facilitar a migração de clientes que hoje utilizam a Z-API e desejam migrar para o como sua solução oficial de API para WhatsApp e demais canais de mensagem.

Sabemos que trocar de provedor de API pode ser um processo trabalhoso — especialmente quando você já tem integrações rodando em produção. Por isso, desenvolvemos essa camada de compatibilidade que mantém a mesma estrutura que você já conhece.

​

O que muda na prática?

As únicas mudanças necessárias na sua aplicação são a base URL e o header de autenticação. Além disso, por utilizar a API oficial do WhatsApp, algumas funcionalidades da Z-API não estão disponíveis. Consulte a página de Limitações da API Oficial para mais detalhes.

	Z-API	Omni Z-API
Base URL	https://api.z-api.io	https://api.omni.z-api.io
Autenticação	Client-Token	Authorization: Bearer {secret}
Nomenclatura	instance_id	channel_id
Path	/instances/	/instances/ ou /channels/
Payloads	—	Mesma estrutura
Webhooks	—	Mesma estrutura

​

Sobre nomenclatura

No , o que antes era chamado de instância (instance_id) agora é tratado como canal (channel_id). O conceito é o mesmo — representa a conexão com um número de WhatsApp — mas adotamos o termo “canal” por ser mais abrangente, já que o suporta múltiplos canais de mensagem além do WhatsApp.

Para compatibilidade, a API aceita tanto /instances/ quanto /channels/ no path. Se você está migrando da Z-API, pode manter /instances/ sem problema — suas integrações continuam funcionando. Para novas integrações, recomendamos usar /channels/.

Ou seja, se hoje sua aplicação faz uma chamada como:

curl -X POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-text \
  -H "Content-Type: application/json" \
  -H "Client-Token: SEU_CLIENT_TOKEN" \
  -d '{"phone": "5511999999999", "message": "Olá!"}'

Basta trocar para:

curl -X POST https://api.omni.z-api.io/channels/SEU_CANAL/token/SEU_TOKEN/send-text \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SEU_SECRET" \
  -d '{"phone": "5511999999999", "message": "Olá!"}'

Note que apenas a base URL e o header de autenticação mudaram — o path e body são idênticos.

O secret para o header Authorization é gerado no painel do Omni Z-API ao criar sua instância. Os payloads de envio e os bodys dos webhooks mantêm exatamente a mesma estrutura, garantindo que suas integrações continuem funcionando sem quebras.

​

Por que migrar?

API Oficial do WhatsApp

Utilize a API oficial do WhatsApp Business com toda a segurança e estabilidade que isso proporciona.

Menor risco de bloqueio

Por utilizar a API oficial do WhatsApp, o risco de banimento é significativamente menor comparado a soluções não oficiais.

Migração simples

Troque apenas a base URL e pronto — suas integrações continuam funcionando.

Suporte dedicado

Conte com o suporte da equipe durante todo o processo de migração.

​

Como migrar

1. Crie sua conta no Omni Z-API

   Acesse o Dashboard e crie sua conta.

2. Configure sua instância

   Crie uma nova instância e conecte seu número de WhatsApp.

3. Atualize a base URL e autenticação

   Substitua https://api.z-api.io por https://api.omni.z-api.io e troque o header Client-Token por Authorization: Bearer SEU_SECRET.

4. Configure os webhooks

   Atualize a URL de callback dos webhooks no Dashboard para apontar para o seu servidor. Os eventos recebidos terão a mesma estrutura de antes.

5. Teste e valide

   Faça testes de envio e recebimento para garantir que tudo está funcionando corretamente.

Precisa de ajuda na migração? Entre em contato pelo e-mail .