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.

Esta documentação cobre o MCP público do IndiqAI: um catálogo de tools exposto por HTTP, pronto para integrações server-to-server, automações e agentes de IA.
O foco desta navegação é a superfície pública autenticada por X-API-Key. Endpoints públicos complementares, como quests públicas e eventos de email, continuam documentados aqui quando fizerem parte da experiência externa.

​
Base URL

Use a base pública abaixo para chamadas manuais ou integrações: https://api.indiqai.com/api/v1/public No playground, o path de cada endpoint é aplicado automaticamente sobre essa base.

​
Como autenticar

As tools autenticadas usam API Key no header X-API-Key: 
X-API-Key: indiqai_sua_chave_aqui
Algumas rotas públicas complementares, como partes de quests públicas e email, seguem contratos próprios descritos na página de cada endpoint. Você pode gerar e revogar chaves no painel em Integrações > API Keys.

​
O que você encontra aqui

Visão geral do MCP

Entenda como usar o MCP público do IndiqAI na prática.

Catálogo de tools

Veja todas as tools disponíveis, o que cada uma faz e o que ela retorna.

Conectar clientes MCP

Configure Claude Code, GitHub Copilot e Codex.

Primeiros passos

Entenda para quem serve, pré-requisitos e por onde começar.

Autenticação

Como autenticar o MCP público com segurança.

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

  • o MCP público é server-to-server e deve ser consumido no backend ou em um adaptador seguro
  • acesso disponível apenas para contas com API Access habilitado
  • limite global de 60 requisições por minuto por API Key nas tools autenticadas
  • três writes críticos aceitam X-Idempotency-Key: crédito de pontos, geração de cupom e carimbo de cartão
  • respostas 429 incluem Retry-After e headers X-RateLimit-*
  • a empresa é derivada automaticamente da chave; você não precisa informar tenant manualmente
  • chave revogada deixa de funcionar imediatamente

​
Próximos passos

  1. Gere uma chave em Integrações > API Keys
  2. Leia a página Usando o MCP do IndiqAI
  3. Leia a página de Autenticação
  4. Se for usar IA, siga o guia de Conectando clientes MCP ao IndiqAI
  5. Consulte o Catálogo de tools
  6. Comece por Clientes ou Produtos