API v1

API Reference

Integre seus agentes de IA com o CRM Plugazap. Crie contatos, gerencie cards no Kanban e registre atividades automaticamente.

Base URLhttps://plugazap.com/api/v1

Autenticação

Todas as requisições requerem uma API key no header Authorization.

json
curl https://plugazap.com/api/v1/contacts \
  -H "Authorization: Bearer pk_live_sua_api_key_aqui"

Como gerar sua API Key

Passo 1
Abra o WhatsApp Web com a extensão Plugazap instalada
Passo 2
Acesse Configurações da Organização no menu
Passo 3
Na seção "API de Integração", clique em "Gerar API Key"
Passo 4
Copie a key — ela não será exibida novamente

Rate Limit

60 requisições por minuto por API key. Headers de resposta indicam o uso:

json
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1713520800

Formato de erros

json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "phoneNumber is required",
    "details": [...]
  }
}
400Dados inválidos ou campos obrigatórios ausentes
401API key inválida, revogada ou ausente
404Recurso não encontrado
409Conflito (ex: contato já existe)
429Rate limit excedido
500Erro interno do servidor

Guia de integração com Agente de IA

Fluxo completo de um agente que recebe mensagem no WhatsApp e atualiza o CRM automaticamente.

1. Buscar se o contato já existe

curl "https://plugazap.com/api/v1/contacts/search?phone=5519999999999" \
  -H "Authorization: Bearer pk_live_sua_key"

2. Se não existe, criar o contato

curl -X POST https://plugazap.com/api/v1/contacts \
  -H "Authorization: Bearer pk_live_sua_key" -H "Content-Type: application/json" \
  -d '{"name":"João Silva","phoneNumber":"5519999999999","contactType":"lead"}'

3. Listar boards e colunas

# Listar boards
curl https://plugazap.com/api/v1/boards -H "Authorization: Bearer pk_live_sua_key"

# Listar colunas
curl https://plugazap.com/api/v1/boards/BOARD_ID/columns -H "Authorization: Bearer pk_live_sua_key"

4. Criar card no funil

curl -X POST https://plugazap.com/api/v1/cards \
  -H "Authorization: Bearer pk_live_sua_key" -H "Content-Type: application/json" \
  -d '{"boardId":"BOARD_ID","columnId":"COL_LEAD_ID","title":"Lead João","value":1500}'

5. Registrar atividade

curl -X POST https://plugazap.com/api/v1/cards/CARD_ID/activities \
  -H "Authorization: Bearer pk_live_sua_key" -H "Content-Type: application/json" \
  -d '{"content":"Cliente demonstrou interesse no plano Pro."}'

6. Mover card quando o status muda

curl -X PATCH https://plugazap.com/api/v1/cards/CARD_ID \
  -H "Authorization: Bearer pk_live_sua_key" -H "Content-Type: application/json" \
  -d '{"columnId":"COL_FECHADO_ID","completionType":"win"}'
Plugazap API v1 · Rate limit: 60 req/min