Primeiros passos

Prepare o cadastro do provedor AtendroZAP, teste o acesso ao servidor e crie a primeira instância da integração.

1. Cadastre o servidor

No backend do Atendro, guarde a URL base e o token administrativo do servidor. O exemplo abaixo usa o servidor 1. Em outra instalação, substitua a URL pelo endereço correspondente.

export ATENDROZAP_URL="https://1.atendro.cloud"
# Defina ATENDROZAP_ADMIN_TOKEN no ambiente privado do seu backend.

Guarde a URL sem /v1, /instance, query ou barra final. O token é o valor configurado em ATENDROZAP_ADMIN_TOKEN nesse servidor. Ele é diferente da senha do console e do segredo do webhook.

O provedor precisa ser implementado no Atendro antes de ativar o cadastro. Vincule cada instância ao servidor e à empresa corretos. Veja servidores e autenticação.

2. Teste saúde e autenticação

curl --request GET "$ATENDROZAP_URL/health/ready"

curl --request GET "$ATENDROZAP_URL/v1/capabilities" \
  --header "admintoken: $ATENDROZAP_ADMIN_TOKEN"

O primeiro endpoint deve responder 200 com status: ready. O segundo verifica o token e informa as capacidades. 401 indica credencial ou header incorreto. O teste de cadastro não precisa conectar uma instância nem enviar mensagens.

3. Configure o receptor de eventos

No console, abra Servidores → servidor → Configurações de webhook. Informe a URL HTTPS do novo receptor no Atendro, o segredo de assinatura e os eventos necessários.

Você também pode usar POST /v1/webhook com admintoken. As novas instâncias herdam o destino global. O guia de webhooks explica as exceções e a desativação por instância.

4. Crie a instância

curl --request POST "$ATENDROZAP_URL/instance/init" \
  --header "admintoken: $ATENDROZAP_ADMIN_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: cadastro-instancia-exemplo-001" \
  --data '{"name":"atendimento-teste","systemName":"Atendro","companyId":"empresa-teste"}'

A resposta é 200 e contém instance.id e instance.token. Guarde ambos no backend antes de continuar. A criação não conecta o WhatsApp. A listagem posterior não recupera o token.

Use uma chave de idempotência nova para cada criação de negócio; mantenha a mesma chave e os mesmos bytes do corpo ao repetir uma tentativa. Consulte erros e idempotência.

5. Faça o pareamento autorizado

Depois de guardar o token da instância em ATENDROZAP_INSTANCE_TOKEN, o fluxo de pareamento usa:

curl --request POST "$ATENDROZAP_URL/instance/connect" \
  --header "token: $ATENDROZAP_INSTANCE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{}'

Execute esse passo somente com o responsável e o telefone autorizados. Mostre o QR apenas na interface privada. Acompanhe GET /instance/status até a sessão estar conectada e autenticada.

Próximo passo

Implemente o recebimento de eventos antes de habilitar automações. Depois, consulte enviar texto, enviar mídia e consultar conversas.