API Pública IndiqAI
A API Pública IndiqAI permite que sistemas externos — como ERPs, PDVs, CRMs e automações — integrem diretamente com a plataforma de fidelização e indicações da sua empresa.Para quem é
- ERPs que precisam registrar vendas e creditar pontos automaticamente
- PDVs que carimbam cartões fidelidade no momento da compra
- CRMs que sincronizam cadastro de clientes
- Automações que geram cupons, consultam métricas ou gerenciam produtos programaticamente
Requisitos
- Plano compatível: seu plano deve incluir
api_access - API Key ativa: gere sua chave no Dashboard > Integrações > Chaves de API
- HTTPS obrigatório: todas as requisições devem usar
https://
Como obter sua API Key
- Acesse o Dashboard da sua empresa
- Navegue até Integrações > Chaves de API
- Clique em Criar nova chave
- Dê um nome descritivo (ex: “ERP Produção”, “PDV Loja Centro”)
- Copie a chave gerada — ela será exibida apenas uma vez
indiqai_xxxx... e deve ser enviada no header X-API-Key de todas as requisições.
Base URL
Selecione o ambiente no seletor de servidor do playground:| Ambiente | URL |
|---|---|
| Produção | https://api.indiqai.com/api/v1/public |
| Develop | https://apidev.indiqai.com/api/v1/public |
Recursos disponíveis
Limites
- Rate limit: 60 requisições por minuto por API Key
- Scopes v1: acesso completo aos recursos da empresa (
["*"]) - Scopes granulares planejados para v2
Próximos passos
Autenticação
Configure sua API Key
Rate Limits
Entenda os limites de uso
Erros
Tratamento de erros padrão
Clientes
Comece listando clientes