> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cardapioweb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Desenvolva com IA

> Use o assistente da documentação, servidor MCP e playground para acelerar sua integração com a API aberta da Cardápio Web.

Ferramentas de IA podem acelerar sua integração quando recebem o contexto certo. Esta documentação oferece um assistente integrado, servidor MCP para editores de código e um playground interativo para você consultar guias, endpoints e schemas sem sair do fluxo de desenvolvimento.

## Escolha como conectar

Cada recurso cobre um momento diferente do trabalho. Você não precisa configurar tudo de uma vez: comece pelo que faz sentido agora e adicione os outros conforme avança na integração.

<CardGroup cols={2}>
  <Card title="Está lendo os guias" icon="message-circle">
    Abra o **assistente de documentação** com **Ctrl+K** (Windows/Linux) ou **Cmd+K** (macOS). Ideal para esclarecer OAuth, webhooks, escopos e fluxos sem trocar de aba.
  </Card>

  <Card title="Está codificando no editor" icon="terminal">
    Conecte o **servidor MCP** no Cursor ou VS Code pelo menu de ações. O agente pesquisa guias e referência da API em tempo real, com o contexto da integração já disponível.
  </Card>

  <Card title="Vai implementar um endpoint" icon="play">
    Use o **playground** na aba Referência da API para testar requisições, validar parâmetros e conferir o formato das respostas antes de escrever código.
  </Card>

  <Card title="Usa outro assistente" icon="external-link">
    No **menu de ações** (ícone de estrelas), copie a página ou abra-a no ChatGPT, Claude ou Perplexity com o conteúdo já carregado como contexto.
  </Card>
</CardGroup>

## Assistente de documentação

Esta documentação inclui um **assistente de IA** integrado ao site. Ele responde perguntas sobre a API aberta, a CW App Store, OAuth, webhooks e demais tópicos cobertos nos guias.

Para abrir o assistente:

1. Clique na **barra de busca** no topo do site ou use **Ctrl+K** (Windows/Linux) ou **Cmd+K** (macOS).
2. Digite sua pergunta e inicie a conversa. Um painel de chat abre à direita da página.

O assistente pesquisa nesta documentação e pode:

* **Citar fontes** com links para as páginas usadas na resposta.
* **Considerar a página atual** como contexto quando você faz uma pergunta.
* **Consultar a referência da API**, incluindo métodos, parâmetros e schemas do OpenAPI.
* **Gerar exemplos de código** prontos para copiar.

<Tip>
  Use o assistente quando estiver lendo um guia e precisar de um esclarecimento sem trocar de ferramenta. Para implementar código no seu projeto, conecte o servidor MCP no editor.
</Tip>

## Menu de ações em cada página

No topo de cada página, o menu de ações (ícone de estrelas) concentra atalhos para enviar o conteúdo atual a ferramentas de IA ou copiá-lo como contexto.

| Ação                                       | O que faz                                                      |
| ------------------------------------------ | -------------------------------------------------------------- |
| **Copiar página**                          | Copia o conteúdo em Markdown para colar no seu assistente.     |
| **Ver como Markdown**                      | Abre a página em texto puro em uma nova aba.                   |
| **Abrir no ChatGPT, Claude ou Perplexity** | Inicia uma conversa com a página já carregada como contexto.   |
| **Conectar ao Cursor ou VS Code**          | Instala o servidor MCP desta documentação no editor.           |
| **Copiar URL do servidor MCP**             | Copia a URL para configurar manualmente em outras ferramentas. |

<Tip>
  Para trabalho contínuo no código, conecte o servidor MCP no seu editor. Para dúvidas isoladas, use o assistente de documentação ou copie a página relevante.
</Tip>

## Servidor MCP

O **Model Context Protocol (MCP)** permite que ferramentas de IA pesquisem nesta documentação em tempo real. Com o servidor conectado, o assistente no seu editor consulta guias e referência da API enquanto você codifica, com o contexto da integração (fluxos, escopos, armadilhas comuns) já disponível pelo próprio servidor.

A URL do servidor é:

```
https://docs.cardapioweb.com/mcp
```

### Conectar no Cursor

<Steps>
  <Step title="Abra o menu de ações">
    Em qualquer página desta documentação, clique no ícone de estrelas no topo e selecione **Conectar ao Cursor**. O editor abre com a configuração pronta.
  </Step>

  <Step title="Ou configure manualmente">
    Abra as configurações de MCP no Cursor e adicione a URL `https://docs.cardapioweb.com/mcp`.
  </Step>
</Steps>

### Conectar no VS Code

<Steps>
  <Step title="Abra o menu de ações">
    Em qualquer página desta documentação, clique no ícone de estrelas no topo e selecione **Conectar ao VS Code**.
  </Step>

  <Step title="Ou configure manualmente">
    Crie um arquivo `.vscode/mcp.json` no seu projeto:

    ```json theme={null}
    {
      "servers": {
        "cardapio-web": {
          "type": "http",
          "url": "https://docs.cardapioweb.com/mcp"
        }
      }
    }
    ```
  </Step>
</Steps>

### Outras ferramentas

Se você usa Claude, Claude Code ou outra ferramenta compatível com MCP, copie a URL do servidor pelo menu de ações e siga as instruções de configuração da ferramenta.

## Referência da API e playground

Na aba **Referência da API**, cada endpoint traz parâmetros, schemas de resposta e um **playground interativo** para testar requisições. Combine essa aba com a IA para gerar exemplos de código alinhados aos contratos reais da API.

<Tip>
  Ao pedir código para a IA, mencione o endpoint específico (por exemplo, `POST /orders`) ou copie a página da referência como contexto. Isso reduz divergências entre o código gerado e o contrato da API.
</Tip>

## Exemplos de prompts

Depois de conectar a documentação à sua ferramenta de IA, você pode pedir, por exemplo:

**Autenticação e CW App Store**

* "Implemente o fluxo OAuth com PKCE para um app da CW App Store em Node.js."
* "Quais escopos OAuth preciso para sincronizar o catálogo e receber novos pedidos?"
* "Como renovar um `access_token` expirado usando o `refresh_token`?"

**Webhooks e pedidos**

* "Crie um handler de webhook para o evento `order_created` que consulte os detalhes do pedido na API."
* "Como deduplicar eventos reenviados por retentativas de webhook?"
* "Qual o fluxo recomendado para alterar o status de um pedido após receber a notificação?"

**Catálogo e loja**

* "Escreva uma função que sincronize o catálogo completo do estabelecimento e trate atualizações incrementais."
* "Quais campos retorna o endpoint de consulta de loja e como mapear os horários de funcionamento?"

## Boas práticas

<AccordionGroup>
  <Accordion title="Valide respostas da IA">
    Respostas geradas podem conter imprecisões. Confira fluxos críticos (autenticação, webhooks, alteração de status) nos [guias oficiais](/primeiros-passos) antes de ir para Produção.
  </Accordion>

  <Accordion title="Teste no Sandbox">
    Use o ambiente Sandbox para validar OAuth, webhooks e chamadas à API. Detalhes em [Sobre a API](/sobre-a-api#ambiente-de-testes-e-de-producao).
  </Accordion>

  <Accordion title="Forneça contexto específico">
    Quanto mais específico o prompt, melhor o resultado. Indique linguagem, framework, módulo da API (Loja, Catálogo ou Pedidos) e o fluxo que você está implementando.
  </Accordion>

  <Accordion title="Combine IA com o playground">
    Depois que a IA gerar um exemplo, teste a requisição no playground da Referência da API para confirmar parâmetros e formato da resposta.
  </Accordion>
</AccordionGroup>

<Warning>
  Não envie credenciais reais (tokens, `client_secret`, chaves de API) em conversas com assistentes de IA. Use valores de teste do Sandbox.
</Warning>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Primeiros passos" icon="play" href="/primeiros-passos">
    Mapa da documentação e trilhas para começar sua integração.
  </Card>

  <Card title="OAuth" icon="key-round" href="/autenticacao/oauth">
    Autorização, tokens, escopos, renovação e erros comuns.
  </Card>

  <Card title="Fluxos de integração" icon="route" href="/fluxo-integracao">
    Módulos Loja, Catálogo e Pedidos: polling, webhooks e status.
  </Card>

  <Card title="Referência da API" icon="code" href="/api-reference/loja/loja/consultar-loja">
    Endpoints, schemas e playground interativo.
  </Card>
</CardGroup>