Primeiros passos

    Início rápido

    Crie uma chave de API e faça a sua primeira requisição em menos de cinco minutos.

    A API do BatZap dá ao seu código a mesma caixa de entrada que o seu time usa: listar conversas, ler mensagens, responder no WhatsApp, etiquetar, atribuir e resolver conversas, e gerenciar grupos. É uma API REST em JSON, servida em uma única URL base.

    URL base
    https://api.batzap.com/v1

    1. Crie uma chave de API

    • Abra o dashboard e vá em Configurações → Chaves de API (dashboard.batzap.com).
    • Clique em Criar chave, dê um nome e escolha os escopos de que ela precisa. Se quiser, restrinja a chave a números de WhatsApp específicos.
    • Copie a chave. Ela aparece uma única vez: o BatZap guarda só um hash dela.

    Só administradores da organização criam e revogam chaves. Uma chave de API nunca consegue criar outra chave.

    2. Faça a primeira requisição

    Envie a chave no header Authorization, sem o prefixo Bearer. GET /health é um bom teste: qualquer chave válida pode chamar.

    cURL
    curl https://api.batzap.com/v1/health \
      -H "Authorization: bzp_live_SUA_CHAVE_DE_API"

    3. Descubra os seus números de WhatsApp

    A maioria das operações de escrita precisa saber de qual número conectado agir. Listar integrações devolve cada número com o seu integration_id. Se a sua chave estiver restrita a um único número, esse id é preenchido automaticamente.

    cURL
    curl https://api.batzap.com/v1/integrations \
      -H "Authorization: bzp_live_SUA_CHAVE_DE_API"

    4. Envie uma mensagem

    Com uma chave que tenha o escopo messages:send, Enviar mensagem entrega uma mensagem no WhatsApp e registra na caixa de entrada, exatamente como se um atendente tivesse digitado.

    O BatZap é uma caixa de entrada de equipe, não uma ferramenta de disparo em massa. O envio é limitado a 10 mensagens por minuto e 300 por dia por chave, e mensagens não solicitadas violam os termos de uso.