Visão Geral da REST API v2

O FeedbackPulse SaaS fornece uma API RESTful (v2) para acesso programático aos dados do seu tenant. Use-a para integrar feedback nos seus próprios apps, construir painéis ou automatizar fluxos de trabalho.

---

URL Base

https://yourdomain.com/api/v2

---

Autenticação

Todas as solicitações da API requerem um token Bearer (chave de API):

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://yourdomain.com/api/v2/submissions

Obtendo uma Chave de API

1. Faça login no seu painel do tenant
2. Vá para Configurações > Chaves de API
3. Clique em Criar Chave de API
4. Copie a chave imediatamente (é exibida apenas uma vez!)

As chaves de API são armazenadas como hashes SHA256. A chave bruta não pode ser recuperada.

Requisito de plano: O acesso à API requer a flag de recurso api_access no seu plano.

---

Limitação de Taxa

Limite	Valor
Requisições por minuto por tenant	60

Os headers de limite de taxa estão incluídos em cada resposta:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

---

Endpoints Disponíveis

Método	Endpoint	Descrição
GET	/api/v2/submissions	Listar submissões
GET	/api/v2/submissions/{id}	Obter uma submissão
POST	/api/v2/submissions	Criar uma submissão
GET	/api/v2/products	Listar produtos
POST	/api/v2/products	Criar um produto
GET	/api/v2/campaigns	Listar campanhas
POST	/api/v2/campaigns	Criar uma campanha
GET	/api/v2/webhooks/config	Obter configuração de webhook
PUT	/api/v2/webhooks/config	Atualizar configuração de webhook
GET	/api/v2/webhooks/logs	Ver logs de entrega de webhook

---

Formato de Resposta

Todas as respostas são JSON:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

Respostas de Erro

{
  "error": "Unauthenticated.",
  "status": 401
}

Código de Status	Significado
200	Sucesso
201	Criado
400	Requisição Inválida (erro de validação)
401	Não Autorizado (chave de API inválida/ausente)
403	Proibido (permissões insuficientes)
404	Não Encontrado
429	Muitas Requisições (limite de taxa atingido)
500	Erro do Servidor

---

Aprofunde-se

• Autenticação — detalhes da chave de API
• API de Submissões — criar e listar feedback
• API de Produtos — gerenciar produtos
• API de Campanhas — gerenciar campanhas
• Webhooks — notificações de eventos em tempo real