Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
MCP público do IndiqAI

O MCP público do IndiqAI organiza as capacidades externas da plataforma como um catálogo de tools consumível por MCP remoto nativo e por HTTP direto.
  • tools autenticadas para operar clientes, pontos, cupons, produtos, fidelidade e métricas
  • rotas públicas complementares para jornadas como quests públicas e eventos de email
Se o seu agente já fala MCP nativamente, conecte o endpoint remoto https://api.indiqai.com/mcp. Você não precisa mais de bridge local para transformar a API pública em tools MCP.

​
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
  • Agentes de IA que precisam operar o IndiqAI por tools previsíveis e autenticadas

​
Requisitos

Para consumir o MCP público autenticado, a conta precisa ter API Access habilitado. Verifique isso no Dashboard antes de integrar.
  1. Plano compatível: sua conta deve ter acesso à API pública habilitado
  2. API Key ativa: gere sua chave em Dashboard > Integrações > Chaves de API
  3. HTTPS obrigatório: todas as requisições devem usar https://
  4. Execução server-side: a chave deve ficar no backend, worker ou cliente MCP configurado com segredo local

​
Como obter sua API Key

  1. Acesse o Dashboard da sua empresa
  2. Navegue até Integrações > Chaves de API
  3. Clique em Criar nova chave
  4. Dê um nome descritivo (ex: “ERP Produção”, “PDV Loja Centro”)
  5. Copie a chave gerada — ela será exibida apenas uma vez
A chave tem o formato indiqai_xxxx... e deve ser enviada no header X-API-Key das tools autenticadas.

​
Endpoints-base

  • MCP remoto nativo: https://api.indiqai.com/mcp
  • HTTP direto da API pública: https://api.indiqai.com/api/v1/public
No playground OpenAPI, o host continua sendo aplicado sobre a base HTTP da API pública.

​
Recursos disponíveis

​
Tools autenticadas

RecursoDescrição
ClientesCadastro e consulta de clientes
CuponsGeração, consulta e uso de cupons
ProdutosCatálogo de produtos
Cartões FidelidadeCartões e carimbos
PontosSaldo e crédito de pontos
MétricasKPIs resumidos da operação
PrêmiosRecompensas disponíveis

​
Rotas públicas complementares

RecursoDescrição
Quests PúblicasQuests, métricas e fluxos públicos de resposta
EmailTracking e opt-out público de email

​
Limites

  • Rate limit global: 60 requisições por minuto por API Key nas tools autenticadas
  • Headers de limite: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset e Retry-After quando houver bloqueio
  • Idempotência suportada: POST /points/credit, POST /coupons/generate e POST /loyalty-cards/{card_id}/stamp
  • algumas rotas de quest/email seguem políticas próprias e não usam X-API-Key

​
Próximos passos

Usando o MCP do IndiqAI

Entenda como usar o MCP público do IndiqAI

Conectando clientes MCP

Configure Claude Code, GitHub Copilot e Codex

Catálogo de tools

Veja as tools disponíveis e o retorno principal de cada uma

Autenticação

Configure sua API Key

Rate Limits

Entenda os limites de uso

Erros

Tratamento de erros padrão

Clientes

Comece pela listagem paginada de clientes