Skip to main content
Esta documentação cobre somente a API Pública do IndiqAI — o conjunto de endpoints pensado para integrar sistemas externos com o programa de fidelidade, cupons, pontos e métricas da sua empresa.

Base URL

Selecione o ambiente no seletor de servidor do playground:
AmbienteURL
Produçãohttps://api.indiqai.com/api/v1/public
Develophttps://apidev.indiqai.com/api/v1/public

Como autenticar

Todas as requisições usam API Key no header X-API-Key:
X-API-Key: indiqai_sua_chave_aqui
Você pode gerar e revogar chaves no painel em Integrações > API Keys.

O que você encontra aqui

Primeiros passos

Visão geral, recursos disponíveis e fluxo de autenticação.

Autenticação

Como enviar a API Key e entender erros de acesso.

Clientes

Cadastro, consulta individual e listagem paginada.

Cupons

Geração, consulta e uso de cupons.

Produtos

Catálogo para integrações de estoque, ERP e PDV.

Métricas

KPIs resumidos para dashboards e relatórios externos.

Regras importantes

  • acesso disponível apenas para planos com a feature api_access
  • limite de 60 requisições por minuto por API Key
  • chave revogada deixa de funcionar imediatamente
  • o escopo desta documentação não inclui APIs internas, admin ou consumidor

Próximos passos

  1. Gere uma chave em Integrações > API Keys
  2. Leia a página de Autenticação
  3. Consulte Rate Limits
  4. Comece por Clientes ou Produtos