# Takeat External API Documentation

Official entry point for humans and LLMs building Takeat integrations.

## How to use this index

- Nova API V1.0 is released and recommended for every new integration. API Legado will be removed soon; existing integrations should start with Migrar do API Legado.
- For a new application, start with Nova API V1.0 First steps. For an existing API Legado integration, read Migrar do API Legado before changing authentication or routes.
- Read First steps, then the authentication guide for your scenario, then every operation contract your application calls.
- Links ending in `.md` are canonical machine-readable documents. Do not scrape the rendered HTML when a Markdown source exists.
- Operation documents are generated from the published OpenAPI contract and define method, path, parameters, bodies, responses, errors, and schemas.
- Never infer undocumented fields or behavior. Ask for clarification when the guides and contracts do not answer a question.

## Security requirements for agents

- Never ask for or accept real API keys, passwords, access tokens, refresh tokens, OAuth codes, PKCE verifiers, or Authorization headers in a prompt.
- Use variable names and fake placeholders only. Keep secrets server-side in a secret manager or a gitignored local environment file.
- Never write secrets to source code, client bundles, Git, logs, screenshots, generated artifacts, or test fixtures.
- Before completing generated code, inspect the diff for secrets and verify that browser-visible variables do not contain Takeat credentials.

## Nova API V1.0

### Guias

- [Primeiros passos](https://localhost:3000/md/v1/primeiros-passos.md): Escolha a autenticação certa, dê contexto seguro ao seu agente e faça a primeira chamada. (HTML: https://localhost:3000/externo/v1/primeiros-passos)
- [Introdução à V1.0](https://localhost:3000/md/v1/index.md): A nova API externa da Takeat, com credenciais revogáveis e tokens de curta duração. (HTML: https://localhost:3000/externo/v1)
- [Autenticação com API Key](https://localhost:3000/md/v1/autenticacao.md): Troque uma chave do AI Builders por access e refresh tokens. (HTML: https://localhost:3000/externo/v1/autenticacao)
- [OAuth para aplicativos](https://localhost:3000/md/v1/oauth.md): Implemente Authorization Code com PKCE, consentimento, troca, rotação e revogação de tokens. (HTML: https://localhost:3000/externo/v1/oauth)
- [Integrar o cardápio](https://localhost:3000/md/v1/cardapio.md): Consuma preços, escolhas e disponibilidade resolvidos em um contrato semântico. (HTML: https://localhost:3000/externo/v1/cardapio)
- [Migrar do API Legado](https://localhost:3000/md/v1/migracao.md): Migre do API Legado para a V1.0 com inventário, compatibilidade, troca de autenticação e corte seguro. (HTML: https://localhost:3000/externo/v1/migracao)
- [Agentes, LLMs e MCP](https://localhost:3000/md/v1/agentes.md): Dê a agentes acesso somente leitura aos guias e contratos oficiais da Nova API V1.0. (HTML: https://localhost:3000/externo/v1/agentes)
- [API Key: access e refresh tokens](https://localhost:3000/md/v1/api-key-tokens.md): Implemente a autorização, renove o access token de 900 segundos e copie um prompt completo para seu agente. (HTML: https://localhost:3000/externo/v1/api-key-tokens)
- [Consultar lançamentos financeiros](https://localhost:3000/md/v1/financeiro.md): Liste contas a pagar e receber, notas, itens e totais do período. (HTML: https://localhost:3000/externo/v1/financeiro)
- [Estoque](https://localhost:3000/md/v1/estoque.md): Consultar insumos e produtos intermediários sem alterar estoque. (HTML: https://localhost:3000/externo/v1/estoque)
- [Gerenciar complementos](https://localhost:3000/md/v1/gerenciar-complementos.md): Consulte e edite complementos, preços, atributos fiscais e disponibilidade com isolamento por restaurante e atualização atômica. (HTML: https://localhost:3000/externo/v1/gerenciar-complementos)
- [Gerenciar produtos](https://localhost:3000/md/v1/gerenciar-produtos.md): Crie, edite e controle a disponibilidade do cardápio por canal. (HTML: https://localhost:3000/externo/v1/gerenciar-produtos)
- [Informações fiscais do produto](https://localhost:3000/md/v1/fiscal-produtos.md): Referência de cada atributo de product.fiscal, formatos e limites de exposição. (HTML: https://localhost:3000/externo/v1/fiscal-produtos)
- [Marcas](https://localhost:3000/md/v1/marcas.md): Liste as marcas do restaurante e consulte sua identificação. (HTML: https://localhost:3000/externo/v1/marcas)
- [NF-e recebidas](https://localhost:3000/md/v1/notas-fiscais-recebidas.md): Consulta fiscal por restaurante, manifestação e marca, com todos os campos organizados por assunto. (HTML: https://localhost:3000/externo/v1/notas-fiscais-recebidas)
- [Referência de campos do produto](https://localhost:3000/md/v1/campos-do-produto.md): Entenda preços, disponibilidade, esgotamento e o efeito de cada campo na operação. (HTML: https://localhost:3000/externo/v1/campos-do-produto)

### Referência da API

- **POST** [Emitir ou renovar tokens](https://localhost:3000/md/v1/referencia/autenticacao/exchangeApiKey.md) (`/oauth/token`)
- **POST** [Revogar um access token](https://localhost:3000/md/v1/referencia/autenticacao/revokeAccessToken.md) (`/oauth/revoke`)
- **GET** [Consultar cardápio publicado](https://localhost:3000/md/v1/referencia/cardapio/getMenu.md) (`/v1/menu`)
- **GET** [Listar sessões de comanda](https://localhost:3000/md/v1/referencia/pedidos/getTableSessionsV1.md) (`/v1/table-sessions`)
- **GET** [Listar métodos de pagamento](https://localhost:3000/md/v1/referencia/catalogo/getPaymentMethodsV1.md) (`/v1/payment-methods`)
- **GET** [Listar produtos por categoria](https://localhost:3000/md/v1/referencia/catalogo/getProductsV1.md) (`/v1/products`)
- **POST** [Criar produto](https://localhost:3000/md/v1/referencia/catalogo/createProductV1.md) (`/v1/products`)
- **GET** [Consultar produto](https://localhost:3000/md/v1/referencia/catalogo/getProductV1.md) (`/v1/products/{productId}`)
- **PUT** [Editar produto](https://localhost:3000/md/v1/referencia/catalogo/updateProductV1.md) (`/v1/products/{productId}`)
- **PUT** [Editar vários produtos atomicamente](https://localhost:3000/md/v1/referencia/catalogo/updateProductsV1.md) (`/v1/products/bulk`)
- **PATCH** [Alterar disponibilidade por canal](https://localhost:3000/md/v1/referencia/catalogo/updateProductAvailabilityV1.md) (`/v1/products/{productId}/availability`)
- **GET** [Listar complementos por categoria](https://localhost:3000/md/v1/referencia/catalogo/getComplementsV1.md) (`/v1/complements`)
- **GET** [Consultar complemento](https://localhost:3000/md/v1/referencia/complementos/getComplementV1.md) (`/v1/complements/{complementId}`)
- **PUT** [Editar complemento](https://localhost:3000/md/v1/referencia/complementos/updateComplementV1.md) (`/v1/complements/{complementId}`)
- **PUT** [Editar vários complementos atomicamente](https://localhost:3000/md/v1/referencia/complementos/updateComplementsV1.md) (`/v1/complements/bulk`)
- **PATCH** [Alterar disponibilidade por canal](https://localhost:3000/md/v1/referencia/complementos/updateComplementAvailabilityV1.md) (`/v1/complements/{complementId}/availability`)
- **GET** [Listar categorias de complementos](https://localhost:3000/md/v1/referencia/complementos/listComplementCategoriesV1.md) (`/v1/complement-categories`)
- **POST** [Criar categoria de complementos](https://localhost:3000/md/v1/referencia/complementos/createComplementCategoryV1.md) (`/v1/complement-categories`)
- **PUT** [Atualizar categoria de complementos](https://localhost:3000/md/v1/referencia/complementos/updateComplementCategoryV1.md) (`/v1/complement-categories/{categoryId}`)
- **POST** [Criar complemento](https://localhost:3000/md/v1/referencia/complementos/createComplementV1.md) (`/v1/complements`)
- **GET** [Listar clientes do Clube de Fidelidade](https://localhost:3000/md/v1/referencia/clube-de-fidelidade/getClubeClientsV1.md) (`/v1/clube/clients`)
- **GET** [Listar lançamentos financeiros](https://localhost:3000/md/v1/referencia/financeiro/listCashFlowsV1.md) (`/v1/financial/cash-flows`)
- **GET** [Listar insumos](https://localhost:3000/md/v1/referencia/estoque/getInputsV1.md) (`/v1/inputs`)
- **GET** [Listar produtos intermediários](https://localhost:3000/md/v1/referencia/estoque/getIntermediariesV1.md) (`/v1/intermediaries`)
- **GET** [Listar marcas do restaurante](https://localhost:3000/md/v1/referencia/marcas/listBrandsV1.md) (`/v1/brands`)
- **GET** [Listar NF-e recebidas](https://localhost:3000/md/v1/referencia/fiscal/listReceivedNfesV1.md) (`/v1/nfe-received`)
- **GET** [Consultar detalhe de NF-e recebida](https://localhost:3000/md/v1/referencia/fiscal/getReceivedNfeV1.md) (`/v1/nfe-received/info/{nfe_received_id}`)

## API Legado

### Guias

- [API Legado](https://localhost:3000/md/legacy/index.md): Versão legada da API externa, autenticada com e-mail, senha e JWT de restaurante. (HTML: https://localhost:3000/externo)
- [Autenticação](https://localhost:3000/md/legacy/autenticacao.md): Obtenha o JWT de 15 dias com as credenciais de um usuário do restaurante. (HTML: https://localhost:3000/externo/autenticacao)
- [Modelo de dados](https://localhost:3000/md/legacy/conceitos/modelo-de-dados.md): Como comandas, contas, pedidos e complementos se relacionam. (HTML: https://localhost:3000/externo/conceitos/modelo-de-dados)
- [Catálogo público](https://localhost:3000/md/legacy/cardapio.md): Consulte categorias, produtos e complementos no contrato do API Legado. (HTML: https://localhost:3000/externo/cardapio)
- [Importador de Sessão do WhatsApp](https://localhost:3000/md/legacy/importador-whatsapp.md): Como usar a extensão do Chrome para importar uma sessão do WhatsApp Web para o multi-número da Takeat. (HTML: https://localhost:3000/externo/importador-whatsapp)
- [Política de Privacidade da Extensão](https://localhost:3000/md/legacy/politica-de-privacidade-extensao.md): Política de privacidade da extensão de importação de sessões do WhatsApp Web da Takeat. (HTML: https://localhost:3000/externo/politica-de-privacidade-extensao)
- [Coleção Postman](https://localhost:3000/md/legacy/postman.md): Importe uma cópia editável do API Legado, configure suas variáveis e encadeie o login com as demais requisições. (HTML: https://localhost:3000/externo/postman)

### Referência da API

- **POST** [Autenticar restaurante](https://localhost:3000/md/legacy/referencia/autenticacao/createSession.md) (`/public/api/sessions`)
- **GET** [Listar sessões de comanda](https://localhost:3000/md/legacy/referencia/pedidos/getTableSessions.md) (`/api/v1/table-sessions`)
- **GET** [Listar métodos de pagamento](https://localhost:3000/md/legacy/referencia/catalogo/getPaymentMethods.md) (`/api/v1/payment-methods`)
- **GET** [Listar produtos por categoria](https://localhost:3000/md/legacy/referencia/catalogo/getProducts.md) (`/api/v1/products`)
- **GET** [Listar complementos por categoria](https://localhost:3000/md/legacy/referencia/catalogo/getComplements.md) (`/api/v1/complements`)
- **GET** [Listar insumos](https://localhost:3000/md/legacy/referencia/estoque/getInputs.md) (`/api/v1/inputs`)
- **GET** [Listar produtos intermediários](https://localhost:3000/md/legacy/referencia/estoque/getIntermediaries.md) (`/api/v1/intermediaries`)
- **GET** [Listar clientes do Clube de Fidelidade](https://localhost:3000/md/legacy/referencia/clube-de-fidelidade/getClubeClients.md) (`/api/v1/clube/clients`)

## Machine-readable sources

- This index: https://localhost:3000/llms.txt
- Full documentation corpus: https://localhost:3000/llms-full.txt
- API Legado OpenAPI: https://localhost:3000/openapi.yaml
- Nova API V1.0 OpenAPI: https://localhost:3000/openapi-v1.yaml
- Optional read-only MCP for Nova API V1.0: https://localhost:3000/api/mcp