Página de Documentação da API
O FeedbackPulse fornece uma página interativa de documentação da API para que os tenants possam explorar e testar os endpoints disponíveis.
Acessando a Documentação da API
Navegue até /api-docs no painel do tenant para visualizar a referência completa da API.
Agrupamento de Endpoints
Os endpoints são organizados por recurso:
| Recurso | Descrição |
|---|---|
| Envios | Criar, ler, atualizar e gerenciar envios de feedback |
| Produtos | Gerenciar produtos e suas configurações |
| Campanhas | Criar e gerenciar campanhas de feedback |
| Webhooks | Configurar e gerenciar assinaturas de webhook |
Detalhes dos Endpoints
Cada entrada de endpoint exibe as seguintes informações:
| Campo | Descrição |
|---|---|
| Método HTTP | O método da requisição (GET, POST, PUT, DELETE) |
| URL | O caminho completo do endpoint |
| Parâmetros | Parâmetros obrigatórios e opcionais com tipos e descrições |
| Exemplo de Requisição | Corpo de requisição ou parâmetros de consulta de exemplo |
| Exemplo de Resposta | Resposta JSON de exemplo com código de status |
Autenticação
A página de documentação da API inclui instruções de autenticação. Todas as requisições à API requerem uma chave de API passada no cabeçalho da requisição:
Authorization: Bearer {your-api-key}
As chaves de API podem ser geradas na página de Configurações do tenant.
Copiar para a Área de Transferência
Cada endpoint inclui um comando cURL pré-construído que pode ser copiado para a área de transferência com um único clique, facilitando o teste de endpoints no terminal.