Voltar para a página inicial

Documentação da ZapGet API

Consulte rapidamente se um número é WhatsApp, obtenha foto de perfil, nome e status.

Esta página é pública. Para ver seus créditos, chave de API e detalhes da conta, acesse o painel autenticado.

Endpoint de Consulta

Use este endpoint em qualquer backend (Node, Python, etc.) ou em plataformas como Make, n8n, Typebot (via HTTP Request), etc.

Request

GET https://zapgetapi.online/api/v1/whatsapp/profile/{phone}

Headers:
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

Parâmetros:
  {phone}: número com DDI. Ex: 5519999999999

Response (exemplo 200)

{
  "statusCode": 200,
  "nome": "João Silva",
  "numero": "5519999999999",
  "numeroExiste": "Sim",
  "isWhatsapp": "Sim",
  "foto": "https://pps.whatsapp.net/...",
  "status": "Hey there! I'm using WhatsApp",
  "requests_left": 99,
  "apiState": "On (FlowGate)"
}

Casos de uso práticos

Ideias simples de como usar a ZapGet API no dia a dia.

• Validar listas de leads antes de disparos em massa, evitando números que não são WhatsApp.

• Enriquecer planilhas ou CRM com nome, foto e status do WhatsApp.

• Mostrar foto e nome do contato em painéis internos de atendimento ou sistemas de suporte.

• Automatizar fluxos em bots (como Typebot / outros) exibindo a foto e o nome da pessoa.

Integração com Typebot (resumo)

Exemplo simples de como montar o fluxo para mostrar a foto de perfil.

  1. Coletar número: use um bloco de pergunta (ex: "Qual seu WhatsApp?") e salve a resposta na variável numero.
  2. Bloco HTTP Request: configure como GET com a URL:
    https://zapgetapi.online/api/v1/whatsapp/profile/{{numero}}
    Adicione o headerAuthorization: Bearer SUA_API_KEY.
  3. Save in variables: na opção de salvar dados do retorno, use:
    Data: {{= data.foto =}}
    Aqui, {phone} da documentação é preenchido automaticamente pela variável{{numero}} do Typebot.
  4. Mostrar imagem: use um bloco de "Image" apontando para a variável{{foto}}.

Limites e Boas Práticas (cache)

• Rate limit (por API key): 5 req/s (burst) e 100 req/min (sustained).

• Cache em servidor (automático): respostas são cacheadas em memória para reduzir carga e acelerar consultas repetidas.

• TTL quando há foto: 5–10 min (atual: ~8 min).

• TTL quando não há foto / sem dados: 2–5 min (atual: ~3 min).

• TTL em erros/falhas: 30–60s (atual: ~45s).

• Soft dedup: se o mesmo número for consultado repetidas vezes em ~20s, a API devolve a última resposta imediatamente.

• Segurança: nunca exponha sua API key direto no frontend do seu site ou Typebot.