Migrando do z-api

​

O que não muda

• A rota continua /instances/{instance_id}/token/{token}/<endpoint>, e só o host passa a ser api.wabox.me.
• O header Client-Token tem o mesmo papel: um segundo segredo, no header, exigido em todas as instâncias da conta. No Wabox o valor é uma API key com a permissão instances:operate. Mantenha o nome do header e troque só o valor. Veja abaixo.
• Os webhooks por tipo (received, delivery, message_status, instance_status, chat_presence) e o campo momment, mantido de propósito.
• O envio continua assíncrono. A resposta imediata traz o id, e o resultado chega no delivery.
• Os nomes da maioria dos endpoints, como send-text, send-image, send-button-list, send-option-list, send-carousel, qr-code, status, phone-exists, queue…
• Vários endpoints da z-api continuam funcionando como alias (/create-group, /profile-picture, /modify-chat, /tags, /send-button-actions…). Veja a coluna “Alias aceito” na tabela de rotas.

​

O que muda

​

Client-Token

curl -X POST https://api.wabox.me/instances/{instance_id}/token/{token}/send-text \
  -H "Client-Token: wbx_key_3f9a1c7e5b2d4f6a8c0e1b3d5f7a9c2e4b6d8f0a1c3ec2e1" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "5511988887777", "message": "Olá!" }'

1. No painel, em Segurança › API keys, crie uma key com a permissão instances:operate.
2. Coloque o valor dela onde o seu código hoje coloca o Client-Token da z-api. O nome do header não muda.
3. Se quiser que o header seja obrigatório (como o token de segurança ativado na z-api), ligue “Exigir API key nas rotas de instância”. Desligado, que é o padrão, o header é ignorado e só o token da URL autentica.

​

Migrando sem parar

​

Adaptador de payload (exemplo)

// Converte um webhook `received` do Wabox para o formato camelCase antigo (subconjunto)
export function toLegacy(event) {
  return {
    type: "ReceivedCallback",
    instanceId: event.instance_id,
    messageId: event.message_id,
    phone: event.phone,
    fromMe: event.from_me,
    fromApi: event.from_api,
    isGroup: event.is_group,
    chatName: event.chat_name,
    senderName: event.sender_name,
    momment: event.momment,
    referenceMessageId: event.reference_message_id,
    text: event.text ? { message: event.text.message } : undefined,
    image: event.image ? { imageUrl: event.image.url, caption: event.image.caption, mimeType: event.image.mime_type } : undefined,
    // ...outros tipos conforme o seu uso
  };
}