Voltar para a página inicial

Documentação da ZapProfile 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://zapprofile.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)

{
  "success": true,
  "data": {
    "is_whatsapp": true,
    "wa_id": "5519999999999@c.us",
    "input": "5519999999999",
    "status": "valid",
    "photo_url": "https://pps.whatsapp.net/...",
    "name": "João Silva",
    "status_message": "Hey there! I'm using WhatsApp"
  },
  "credits_remaining": 99,
  "foto": "https://pps.whatsapp.net/...",
  "numero": "5519999999999",
  "numeroExiste": true
}

Casos de uso práticos

Ideias simples de como usar a ZapProfile 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://zapprofile.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}}.

Dica: se quiser ver o fluxo completo com prints, acesse a documentação detalhada dentro do painel autenticado (Dashboard > Documentação > Integração com Typebot).

Limites e Boas Práticas (resumo)

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

• Timeout recomendado no cliente: 20s (a API costuma responder em até 10s).

• Faça cache dos resultados sempre que possível (ex: 24h).

• Nunca exponha sua API key direto no frontend do seu site ou Typebot.

Tier 1 vs Tier 2

Prioridade e provedor variam conforme o plano.

• Tier 1 (FREE): usa provedor externo (Green API). Pode ter menor estabilidade e não depende de QR no FlowGate.

• Tier 2 (PAGO): usa Baileys via FlowGate com slot dedicado (userId → slotId fixo). Requer instância conectada no dashboard.

Cache (automático)

Para reduzir carga no WhatsApp e acelerar respostas, a API usa cache em memória no servidor.

• Com foto: cache ~8 min.

• Sem foto / sem dados: cache ~3 min.

• Erros/falhas: cache ~45s.

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