> ## 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.

# Introdução

> Visão geral do MCP público do IndiqAI, pré-requisitos e blocos disponíveis

# 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

<Note>
  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.
</Note>

## 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

<Warning>
  Para consumir o MCP público autenticado, a conta precisa ter **API Access** habilitado. Verifique isso no Dashboard antes de integrar.
</Warning>

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

| Recurso                                                            | Descrição                         |
| ------------------------------------------------------------------ | --------------------------------- |
| [Clientes](/api-reference/public-api/clients/list)                 | Cadastro e consulta de clientes   |
| [Cupons](/api-reference/public-api/coupons/generate)               | Geração, consulta e uso de cupons |
| [Produtos](/api-reference/public-api/products/list)                | Catálogo de produtos              |
| [Cartões Fidelidade](/api-reference/public-api/loyalty-cards/list) | Cartões e carimbos                |
| [Pontos](/api-reference/public-api/points/balance)                 | Saldo e crédito de pontos         |
| [Métricas](/api-reference/public-api/metrics/overview)             | KPIs resumidos da operação        |
| [Prêmios](/api-reference/public-api/rewards/list)                  | Recompensas disponíveis           |

### Rotas públicas complementares

| Recurso                                                  | Descrição                                      |
| -------------------------------------------------------- | ---------------------------------------------- |
| [Quests Públicas](/api-reference/public-api/quests/list) | Quests, métricas e fluxos públicos de resposta |
| [Email](/api-reference/public-api/email/opt-out-preview) | Tracking 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

<CardGroup cols={2}>
  <Card title="Usando o MCP do IndiqAI" icon="shield-check" href="/api-reference/public-api/mcp-indiqai">
    Entenda como usar o MCP público do IndiqAI
  </Card>

  <Card title="Conectando clientes MCP" icon="bot" href="/api-reference/public-api/agent-integrations">
    Configure Claude Code, GitHub Copilot e Codex
  </Card>

  <Card title="Catálogo de tools" icon="list-tree" href="/api-reference/public-api/tools-catalog">
    Veja as tools disponíveis e o retorno principal de cada uma
  </Card>

  <Card title="Autenticação" icon="key" href="/api-reference/public-api/authentication">
    Configure sua API Key
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/api-reference/public-api/rate-limits">
    Entenda os limites de uso
  </Card>

  <Card title="Erros" icon="triangle-exclamation" href="/api-reference/public-api/errors">
    Tratamento de erros padrão
  </Card>

  <Card title="Clientes" icon="users" href="/api-reference/public-api/clients/list">
    Comece pela listagem paginada de clientes
  </Card>
</CardGroup>