Documentação para desenvolvedores
Tudo para o seu sistema registrar clientes e notas de 0 a 10, gerar links de pesquisa, ler o NPS e receber webhooks quando aparece um detrator.
Quickstart
Da chave de API à primeira nota: autenticação, cliente, nota, link de pesquisa e métricas.
Webhooks
Eventos, cabeçalhos, retentativas e como validar a assinatura HMAC em Python e Node.
Referência OpenAPI
Todos os endpoints e campos no Swagger gerado do próprio código.
Coleção do Postman
As chamadas principais montadas, com as variáveis base_url e api_key.
Servidor MCP (em breve para clientes)
Consulte NPS, respostas e clientes a partir de um agente de IA, com a chave da sua conta.
Changelog
O que mudou na API, por data.
O que vale para toda a API
| Base | https://api.profeedback.com.br/v1 |
|---|---|
| Autenticação | Authorization: Bearer pf_live_... (produção) ou pf_test_... (sandbox, separado da produção e sem consumir cota). Chaves criadas no painel, em Chaves de API, com escopo leitura ou completo. |
| Formato | JSON em UTF-8. Datas em ISO 8601; filtros de período em AAAA-MM-DD, no fuso de São Paulo. |
| Erros | {"error": {"code", "message", "details"}}. 400 entrada inválida, 401 chave inválida, 403 escopo ou cadastro incompleto, 402 período de teste encerrado, 404 não encontrado, 409 conflito, 429 cota do mês ou limite da chave (com Retry-After). |
| Idempotência | Envie Idempotency-Key em POST /v1/responses: repetir a mesma chave devolve a nota já registrada, sem novo consumo. |