AvaliaBemAvaliaBem

Documentacao da API

A API do AvaliaBem permite integrar seu sistema com nossa plataforma de gestao de reviews. Automatize o cadastro de clientes e atendimentos usando ferramentas como n8n, Zapier, Make ou sua propria integracao.

Navegacao rapida

AutenticacaoEndpointsClientesAtendimentosMetricasErrosExemplos

Autenticacao

Importante: Todas as requisicoes requerem autenticacao via Bearer Token. O token e vinculado a um estabelecimento especifico.

Obtendo seu Token

Entre em contato com o administrador do AvaliaBem para solicitar um token. Informe:

  • Nome da integracao (ex: "Minha Clinica - n8n")
  • Email do estabelecimento cadastrado

Usando o Token

Inclua o token no header Authorization de todas as requisicoes:

Authorization: Bearer seu-token-aqui

Endpoints

Base URL: https://seu-dominio.com/api/v1

GET/me
GET/customers
POST/customers
GET/customers/:id
PUT/customers/:id
DELETE/customers/:id
GET/customers/lookup
GET/appointments
POST/appointments
GET/appointments/:id
GET/metrics

Clientes

POST/customers

Criar Cliente

Request Body

{
  "name": "Nome do Cliente",
  "phone": "11999887766",
  "email": "cliente@email.com"  // opcional
}

Response (201 Created)

{
  "success": true,
  "data": {
    "id": "clxyz123...",
    "name": "Nome do Cliente",
    "phone": "5511999887766",
    "phoneDisplay": "(11) 99988-7766",
    "createdAt": "2024-12-29T10:00:00Z"
  }
}
GET/customers/lookup?phone=11999887766

Buscar por Telefone

// Encontrado
{ "found": true, "customer": { "id": "...", "name": "...", "phone": "..." } }

// Nao encontrado
{ "found": false }

Atendimentos

POST/appointments

Criar Atendimento

Use customerId para cliente existente ou customer para criar junto.

Cliente existente

{
  "customerId": "clxyz123...",
  "description": "Consulta"
}

Criar cliente junto

{
  "customer": {
    "name": "Nome",
    "phone": "11999887766"
  }
}

Status do Atendimento

PENDINGAguardando envio
MESSAGE_SENTMensagem enviada
FEEDBACK_RECEIVEDFeedback recebido
REVIEW_REQUESTEDReview solicitado
COMPLETEDFinalizado
FAILEDErro no envio

Metricas

GET/metrics?period=7d

Parametro period: 7d (padrao), 30d, ou all

{
  "period": "last_7_days",
  "appointments": { "total": 50, "pending": 5, "completed": 40 },
  "feedbacks": { "total": 35, "positive": 30, "negative": 5, "responseRate": 70 },
  "customers": { "total": 100 }
}

Codigos de Erro

400Dados invalidos
401Token invalido
404Nao encontrado
500Erro interno

Formato de erro

{
  "success": false,
  "error": "Mensagem de erro"
}

Exemplos Praticos

cURL - Criar Atendimento

curl -X POST https://seu-dominio.com/api/v1/appointments \
  -H "Authorization: Bearer seu-token-aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": { "name": "Maria Silva", "phone": "11999887766" },
    "description": "Limpeza dental"
  }'

n8n / Make / Zapier

Configure um webhook HTTP:

  • Method:POST
  • URL:/api/v1/appointments
  • Header:Authorization: Bearer token
  • Body:JSON com customer.name e customer.phone

Pronto para integrar?

Entre em contato para receber seu token de acesso

suporte@avalia-bem.com