Takeat
Versão da documentação
Ferramentas e MCP

Documentação

Conecte a Takeat à sua IA

Use a IA para consultar dados do seu restaurante ou criar uma integração com a Takeat.

O MCP é uma conexão entre a Takeat e um assistente de IA, como ChatGPT, Claude ou Codex. Depois que você autoriza o acesso, pode conversar com o assistente sobre os dados do seu restaurante ou pedir ajuda para criar uma aplicação conectada à Takeat.

Por exemplo, você pode perguntar:

  • “Quais produtos estão disponíveis nas minhas marcas?”
  • “Quais foram as movimentações financeiras do meu restaurante?”
  • “Qual foi o tempo médio de preparo na cozinha neste mês, por estação?”
  • “Quero criar um app que consulte produtos da Takeat. Por onde começo?”

Para perguntas sobre o restaurante, a IA consulta apenas os dados que você autorizou. Para ajudar a criar um app, ela consulta a documentação oficial da API. Se não estiver claro qual é a sua intenção, ela deve perguntar antes de continuar. Por padrão, a conexão somente consulta informações. Ela só altera dados, como produtos, estoque ou baixas financeiras, quando você aprova as permissões de escrita correspondentes e pede a alteração; veja Alterações pelo assistente. O MCP não cria pedidos.

Como conectar

Use este endereço no aplicativo de IA:

https://public-api.takeat.app/mcp
  1. Adicione o endereço acima como uma conexão MCP no aplicativo.
  2. Quando o navegador abrir, entre na sua conta Takeat.
  3. Escolha o restaurante e as marcas que a IA poderá consultar.
  4. Confira as permissões e confirme.

Pronto: volte ao aplicativo de IA e faça sua pergunta. Você não precisa criar nem colar uma chave de API para conectar pelo login do navegador.

Teste a conexão antes de usar

Logo depois de conectar, abra uma conversa nova e cole o prompt de Testar a conexão MCP. Ele confirma restaurante, marcas, permissões, documentação e paginação em uma resposta e explica o que fazer se algum passo falhar.

Para autorizar várias lojas da mesma rede, siga o guia de integrações para multilojas.

Você decide quais marcas compartilhar

É possível autorizar uma ou várias marcas do mesmo restaurante. A IA não consegue acessar marcas que você não escolheu. Para mudar o restaurante ou o conjunto de marcas, faça uma nova autorização.

Escolha seu aplicativo

No aplicativo Claude para desktop, abra Configurações → Conectores:

  1. Clique em Adicionar → Adicionar conector personalizado.
Tela de Conectores do Claude com o menu Adicionar conector personalizado aberto
Abra a criação de um conector personalizado nas configurações do Claude. Clique ou toque para ampliar.
  1. Dê um nome, como Takeat MCP Dados, cole https://public-api.takeat.app/mcp no campo de endereço e clique em Continuar.
Formulário do Claude com o nome Takeat MCP Dados e o endereço do servidor MCP preenchidos
Use o endereço completo do servidor MCP da Takeat. Clique ou toque para ampliar.
  1. Em Autenticação, escolha Entrar agora. Em Cliente OAuth, mantenha Registrar automaticamente. Não adicione cabeçalhos de requisição. Conclua o login e a autorização Takeat quando o navegador abrir.
Opções de autenticação do Claude com Entrar agora e Registrar automaticamente selecionados
O Claude detecta o login OAuth e registra o cliente automaticamente. Clique ou toque para ampliar.
  1. Depois da autorização, o conector aparece em Seus conectores. Abra-o para ver as ferramentas de consulta e definir quando o Claude pode usá-las.
Conector Takeat MCP Dados no Claude mostrando as permissões das ferramentas de somente leitura
Confira as ferramentas disponíveis e suas permissões no conector. Clique ou toque para ampliar.

No aplicativo Codex, abra Configurações → Plugins → MCPs:

  1. Clique em Add → Add MCP server.
Configurações do Codex na aba MCPs com a opção Add MCP server aberta
Adicione um servidor MCP nas configurações de Plugins do Codex. Clique ou toque para ampliar.
  1. Escolha Streamable HTTP, dê um nome ao servidor e cole https://public-api.takeat.app/mcp em URL. Deixe Bearer token env var e os campos de cabeçalhos vazios; clique em Save.
Formulário do Codex para um MCP Streamable HTTP com o endereço da Takeat preenchido
Use Streamable HTTP e o endereço MCP; o login será feito pelo navegador. Clique ou toque para ampliar.
  1. Na lista de servidores, clique em Authenticate ao lado da conexão Takeat. Conclua o login e a autorização no navegador e volte ao Codex. Inicie uma nova tarefa para usar as ferramentas.
Lista de servidores MCP do Codex com o servidor Takeat habilitado e o botão Authenticate
Autentique a conexão após salvar o servidor. Clique ou toque para ampliar.

Se preferir o terminal, execute:

codex mcp add takeat --url https://public-api.takeat.app/mcp
codex mcp login takeat --oauth-client-registration dcr

Conclua a autorização no navegador e inicie uma nova sessão.

Crie um conector MCP remoto personalizado no ChatGPT com o endereço https://public-api.takeat.app/mcp. Quando o aplicativo solicitar, conclua o login e a autorização Takeat no navegador. As telas e a disponibilidade de conectores personalizados podem variar conforme sua conta e seu plano.

No terminal, execute:

claude mcp add --transport http takeat https://public-api.takeat.app/mcp

Siga as instruções do Claude Code e conclua a autorização no navegador.

O que acontece quando faço uma pergunta?

Se você perguntar sobre o seu restaurante, o assistente usa as ferramentas de consulta disponíveis: cardápio, produtos, complementos, comandas, formas de pagamento, financeiro, marcas, notas fiscais recebidas, estoque, Clube, categorias de produtos, fichas técnicas, avaliações e relatórios de pagamentos, clientes, produtos e KDS, de acordo com as permissões concedidas.

Se você pedir ajuda para criar ou corrigir uma aplicação, o assistente consulta os guias e contratos oficiais da API Takeat antes de sugerir a integração. Você pode pedir, por exemplo: “Mostre como meu app pode consultar produtos usando a API da Takeat”.

Quando uma ferramenta permite escolher marcas, você pode perguntar sobre uma marca específica, sobre várias ou não mencionar nenhuma. Sem especificar marcas, a consulta considera todas as marcas que você autorizou, nunca as demais marcas do restaurante.

Criar um app exige uma autorização própria

O login acima autoriza o assistente a usar o MCP. Se você criar um app que acessará a API Takeat por conta própria, o app precisará implementar a autenticação descrita na documentação da API. A autorização do assistente não substitui a do app.

Ferramentas de consulta

Toda conexão MCP precisa de menu:read; sem ela, o servidor recusa qualquer chamada com 403. Além disso, cada ferramenta só funciona se a permissão correspondente foi aprovada no consentimento. Sem ela, a ferramenta responde “Permissão necessária ausente: <escopo>. Reconecte e revise o consentimento.”

FerramentaO que respondePermissão
list_restaurantsIDs e nomes das lojas autorizadas (multilojas)—
get_restaurant_contextRestaurante, marcas e permissões desta conexão—
get_menuItens publicados por canal, com preço e disponibilidade (padrão in_store)menu:read
get_products, get_productCatálogo completo de produtos e detalhe por IDproducts:read
get_product_categories, get_product_categoryCategorias de produtos das marcas autorizadasproducts:read
get_complements, get_complement, get_complement_categoriesComplementos, grupos de escolha e suas regrascomplements:read
get_table_sessionsComandas: pedidos, pagamentos, cupons e notas, sem limite de diastable-sessions:read
get_payment_methodsFormas de pagamento aceitaspayment-methods:read
get_financial_cash_flowsLançamentos financeiros, até 92 dias, páginas de 100financial:read
get_cost_centers, get_bank_accounts, get_cash_flow_payment_methodsIDs usados nas escritas financeirasfinancial:read
get_brandsDados públicos e fiscais das marcas autorizadasbrands:read
get_received_invoices, get_received_invoice_infoNF-e de fornecedores, até 92 dias, e detalhe por notanfe-received:read
get_inventory_inputs, get_inventory_input, get_inventory_inputs_registrationsInsumos ativos, cadastro por ID e lista paginada de cadastrosinputs:read
get_inventory_intermediaries, get_inventory_intermediary, get_inventory_intermediaries_registrationsIntermediários, cadastro por ID e lista paginadaintermediaries:read
get_product_technical_sheetComposição e custo do produtoproducts:read
get_complement_technical_sheetComposição e custo do complementocomplements:read
get_intermediary_technical_sheetComposição por lote, rendimento e custointermediaries:read
get_clientsClientes vinculados à loja, com ou sem Clubeclients:read
get_clube_clientsClientes do programa de fidelidadeclube:read
get_ratingsAvaliações, resumo e paginação; até 92 diasratings:read
get_payments_report, get_customers_report, get_products_report, get_kds_reportRelatórios (veja abaixo)reports:<família>:read
search_documentation, get_documentation_page, list_api_operationsGuias e contratos oficiais; não leem dados—

Os campos de cada resposta são os da rota REST equivalente; consulte a referência, onde cada campo tem descrição. Para exemplos de perguntas por assunto, veja Consultar dados com o MCP.

As consultas individuais recebem id. Cadastros paginados recebem offset. Avaliações recebem start_date e end_date em AAAA-MM-DD (UTC), além de page, per_page e channel opcionais. Continue com pagination.next. As listas legadas get_inventory_inputs e get_inventory_intermediaries continuam disponíveis com seus contratos anteriores.

get_clients recebe page, per_page (padrão 25, máximo 50) e o filtro booleano opcional registered_in_clube. Omita o filtro para todos; use false para quem não tem cadastro ativo no Clube da loja. Funciona sem Clube configurado. Continue com pagination.next, preservando a loja e o filtro. Veja Clientes e Clube. A permissão precisa ser aprovada na conexão; clube:read não substitui clients:read.

Relatórios

Os mesmos relatórios do painel e das rotas de Relatórios estão disponíveis em uma ferramenta por família:

FerramentaRelatóriosPermissão
get_payments_reportFaturamento por dia ou mês, por forma de pagamento e por canal; transações e atendimentosreports:payments:read
get_customers_reportResumo, retenção, frequência de visitas, funil e listas de clientesreports:customers:read
get_products_reportVendas de hoje, resumo, produtos, categorias, complementos, canais, curva ABC, matriz BCG, participação nos pedidos e cancelamentosreports:products:read
get_kds_reportTempos de espera, preparo e total, cumprimento da meta, por dia, estação, canal, produto e garçom, mapa de calor e pedidos mais lentosreports:kds:read

Cada ferramenta recebe report, que é o caminho da rota abaixo de /v1/reports/<família>/, como summary, period/products ou overview, e os mesmos filtros dessa rota. A descrição da ferramenta lista os relatórios e os filtros de cada um. Um filtro que o relatório escolhido não aceita é recusado, e a mensagem informa os filtros aceitos. Os cálculos, a validação e o corpo da resposta são os da rota; a ferramenta devolve esse corpo em data.

Datas usam AAAA-MM-DD e meses AAAA-MM. Filtros de lista, como kds_ids, channels ou compare, aceitam texto separado por vírgulas ou uma lista. Os relatórios do KDS exigem start_date e end_date, cobrem até 92 dias e trazem os tempos em segundos (campos terminados em _s). Quando a resposta trouxer next_cursor, repita a consulta com cursor e os mesmos filtros.

{
  "report": "overview",
  "start_date": "2026-10-01",
  "end_date": "2026-10-31",
  "compare": "previous"
}

Conexões criadas antes desta versão não recebem as permissões de relatórios automaticamente. Para usá-las, reconecte o cliente MCP e aprove as permissões de relatórios. Uma chave MCP manual guarda os escopos escolhidos na criação: crie outra chave com as permissões de relatórios e revogue a anterior.

Alterações pelo assistente

O MCP também pode alterar dados quando a conexão possui a permissão de escrita correspondente e você solicita a alteração. Uma conexão apenas de leitura continua sem poder gravar, mesmo que o cliente mostre as ferramentas de escrita.

FerramentasPermissão
create_product, create_products, update_product, update_products, set_product_availability, upload_product_imageproducts:write
create_product_category, update_product_categoryproducts:write
create_complement, update_complement, update_complements, set_complement_availabilitycomplements:write
create_complement_category, update_complement_categorycomplements:write
create_inventory_inputs, update_inventory_input, update_inventory_inputsinputs:write
create_inventory_intermediaries, update_inventory_intermediary, update_inventory_intermediariesintermediaries:write
replace_product_technical_sheet, replace_product_technical_sheetsproducts:write
replace_complement_technical_sheet, replace_complement_technical_sheetscomplements:write
replace_intermediary_technical_sheet, replace_intermediary_technical_sheetsintermediaries:write

Edições individuais recebem id e body; criações individuais recebem body. Operações em lote recebem items com 1 a 100 entradas; edições exigem IDs distintos. Os campos de body e de cada item seguem os contratos REST correspondentes. Use expected_updated_at quando o contrato oferecer esse campo; conflitos exigem nova consulta e revisão. As disponibilidades presencial e delivery são independentes.

Fichas técnicas substituem a composição completa: envie inputs e intermediaries, com id e quantidade decimal em texto em cada ingrediente. Arrays vazios removem os ingredientes. Fichas de intermediários também exigem yield e usam quantidades por lote. Alterações preservam saldos e preços de venda, mas podem recalcular custos de itens dependentes.

upload_product_image recebe content_base64, content_type e filename opcional. Aceita JPEG, PNG ou WebP, com limite de 10 MB decodificados e sujeito ao limite HTTP da implantação. O retorno contém id, usado como image_id no produto.

No registro dinâmico (POST /oauth/register), omitir scope solicita apenas leituras. Para escrever, o cliente precisa solicitar os escopos desejados no campo scope, incluindo menu:read, e o dono precisa aprovar essa lista no consentimento. Conexões existentes não ganham permissões ao atualizar o servidor nem ao renovar o token. Atualize explicitamente as permissões do cliente e autorize novamente, ou crie uma nova conexão solicitando os escopos necessários. Uma chave MCP manual guarda exatamente os escopos solicitados; para mudá-los, crie outra chave.

As ferramentas de escrita são identificadas como alterações, e não como consultas. Não repita uma criação automaticamente após falha de comunicação: consulte o estado atual primeiro. O MCP não expõe exclusões, administração de credenciais, nem a publicação central de cardápios multilojas, que exige o perfil de integração próprio dessa API.

Acesso e limites

Você pode revogar a autorização do MCP. Isso interrompe o acesso daquela conexão, inclusive dos acessos já concedidos. A Takeat registra informações básicas de uso por 90 dias para segurança e diagnóstico, mas não armazena a chave secreta, o cabeçalho de autorização nem as respostas completas das consultas.

Cada conexão tem um limite de 60 consultas por minuto e 5.000 por dia. Se o limite for atingido, aguarde e tente novamente.

Paginação de dados

As ferramentas paginadas retornam data e pagination. O assistente deve continuar com os parâmetros de pagination.next, mantendo a loja e os filtros, até pagination.has_more=false. Se consultar apenas algumas páginas, deve informar que a análise cobre parte dos dados. O cardápio mantém os grupos por marca e categoria em data; pagination.count conta produtos.

get_table_sessions aceita qualquer intervalo válido, com limit de 1 a 100 (padrão 50) e cursor. A página inclui todas as marcas selecionadas em uma consulta, e cada sessão identifica sua marca por brand_id. Em multilojas, use list_restaurants e consulte cada loja explicitamente.

Veja o formato comum de paginação.

Configuração avançada

As informações abaixo são para quem configura clientes MCP ou investiga uma falha de conexão. Se você usa ChatGPT, Claude ou Codex com login pelo navegador, normalmente não precisa delas.

Cliente sem login pelo navegador

Se o seu cliente MCP não aceita o login automático, crie uma chave MCP no Developers Portal. Escolha o restaurante e as marcas permitidas. Copie a chave no momento da criação: o segredo aparece somente uma vez.

POST /mcp HTTP/1.1
Host: public-api.takeat.app
Authorization: Bearer tk_mcp_live_<key_id>_<secret>
Content-Type: application/json

Chaves da API REST (tk_live_... e tk_test_...) não funcionam no MCP, e chaves MCP não funcionam nas rotas REST. Nunca coloque a chave em uma pergunta à IA, URL, log ou código que roda no navegador. Se precisar trocar de chave, crie outra e revogue a anterior.

Descoberta e permissões

Clientes compatíveis encontram automaticamente a configuração de autorização a partir de https://public-api.takeat.app/mcp. Para diagnóstico, os metadados estão em:

https://public-api.takeat.app/.well-known/oauth-protected-resource/mcp
https://public-api.takeat.app/.well-known/oauth-authorization-server

O servidor usa OAuth 2.1, registro dinâmico de clientes e PKCE S256. As respostas usam Streamable HTTP com SSE, preservando notificações durante a chamada e enviando um sinal de atividade a cada cinco segundos enquanto o fluxo permanece aberto. O cliente deve consumir o fluxo até o resultado JSON-RPC final; uma notificação ou sinal de atividade não conclui a operação. Endereços de retorno precisam corresponder exatamente aos registrados. A autorização cria uma credencial MCP interna, visível e revogável, sem exibir segredo bruto. Tokens OAuth e chave manual associados à mesma credencial compartilham os limites; o dia da cota segue UTC.

As ferramentas de documentação são search_documentation, get_documentation_page e list_api_operations. O prompt MCP build_takeat_integration ajuda a planejar integrações; veja Prompts. Para dados do restaurante, o assistente começa por get_restaurant_context e usa as ferramentas de consulta adequadas. O restaurante vem da credencial; o cliente não pode trocá-lo enviando restaurant_id. Nas ferramentas com brand_ids, omitir esse campo consulta todas as marcas autorizadas; preenchê-lo restringe a consulta a uma ou mais marcas já autorizadas.

Se algo não funcionar

O que apareceuO que fazer
401Conecte novamente o cliente MCP. Não use uma chave REST.
403Confira as permissões e as marcas escolhidas na autorização.
429Aguarde o tempo indicado em Retry-After antes de tentar de novo.
Página de documentação indisponívelTente novamente; a consulta usa as fontes oficiais em docs.takeat.app.
Cursor inválidoRecomece a consulta com os mesmos filtros, sem o cursor.

Contagens de estoque via integração

inputs:stock:write e intermediaries:stock:write autorizam registrar contagens físicas e alterar saldo real, individualmente ou em lote. Exigem access token de integração, versão atual do saldo e idempotência. Não são concedidos por inputs:write/intermediaries:write nem por sessões humanas. Credenciais existentes precisam de seleção explícita e novo token/consentimento.

Veja contagens de estoque para rotas, ferramentas MCP, payloads e recuperação de conflitos. O cadastro e as fichas técnicas continuam preservando quantidades.

Ferramenta de contagemScope
register_inventory_input_count, register_inventory_input_countsinputs:stock:write
register_inventory_intermediary_count, register_inventory_intermediary_countsintermediaries:stock:write

Use as ferramentas cadastrais get_inventory_input, get_inventory_intermediary ou suas listas de cadastros para obter stock_version antes de contar. As ferramentas de contagem recebem idempotency_key; as individuais recebem id e os campos da contagem diretamente, sem body. As ferramentas em lote recebem items. Consulte o contrato e o tratamento de conflitos.

Financeiro e centros de custo

FerramentaScopeO que faz
get_cost_centers, get_bank_accounts, get_cash_flow_payment_methodsfinancial:readLista os IDs da loja usados nas escritas
update_cash_flow_settlement, update_cash_flow_settlementsfinancial:writeDá baixa ou desfaz a baixa de 1 a 100 lançamentos, com data, conta e forma de pagamento; altera o saldo bancário
set_input_cost_center, set_input_cost_centersinputs:writeTroca só o centro de custo de 1 a 100 insumos, inclusive os replicados pela multilojas

As ferramentas de escrita não fazem parte do registro padrão somente leitura; reconecte o cliente e aprove financial:write para usá-las. Os campos são os mesmos das rotas: veja lançamentos financeiros e centro de custo dos insumos.

Cupom utilizado em cada compra

Cada comanda retornada por get_table_sessions inclui coupons, também disponível em GET /v1/table-sessions, GET /v2/table-sessions e GET /v1/table-sessions/{sessionId}. Sem usos válidos, o campo é [].

Cada item contém transaction_id, id (ID do cupom), code, name (pode ser null), title, discount_type, discount e currency. discount é o valor monetário registrado na compra, como "12.50", inclusive quando o tipo é percentage; não é o percentual nem um valor recalculado pela regra atual.

Usos cancelados e vínculos ausentes ou de outro restaurante são omitidos. Cupons globais são aceitos. Cupons atualmente inativos ou excluídos logicamente continuam identificáveis no histórico. Código, nome e título refletem o cadastro atual; tipo, valor e moeda refletem a transação. Os usos são ordenados pelo ID da transação.

Filtrar comandas por desconto ou cupom

As listagens GET /v1/table-sessions, GET /v2/table-sessions e a ferramenta get_table_sessions aceitam os mesmos filtros opcionais:

CampoCorrespondência
discount_obsTrecho literal da observação de desconto, sem diferenciar maiúsculas.
coupon_idID exato do cupom, inteiro de 1 a 2147483647.
coupon_codeCódigo atual exato, diferenciando maiúsculas.
coupon_titleTrecho literal do título atual, sem diferenciar maiúsculas.
coupon_typeTipo registrado no uso: percentage, absolute ou free-shipping.

Filtros de texto são aparados e devem conter entre 1 e 255 caracteres. % e _ são caracteres literais, não curingas. Todos os filtros são combinados com AND; os critérios de cupom precisam corresponder ao mesmo uso não cancelado. Vínculos de outro restaurante ou sem cadastro de cupom não correspondem. Cupons globais e usos históricos de cupons hoje inativos ou excluídos logicamente são aceitos.

A filtragem ocorre antes da paginação. As comandas selecionadas mantêm a resposta completa, incluindo todos os seus cupons válidos. Nenhuma correspondência retorna uma lista vazia. Na V2 e no MCP, mantenha os filtros ao enviar pagination.next; um cursor reutilizado com filtros diferentes é rejeitado.

Exemplo de argumentos do MCP:

{
  "start_date": "2026-11-01",
  "end_date": "2026-11-06",
  "discount_obs": "campanha",
  "coupon_code": "SAVE10",
  "coupon_type": "percentage",
  "limit": 50
}

Filtrar comandas por cliente

GET /v1/table-sessions, GET /v2/table-sessions e get_table_sessions aceitam:

CampoCorrespondência
buyer_idID exato de buyers.id, inteiro de 1 a 2147483647. Não é o client_id do Clube.
buyer_phoneTelefone completo com 55 + DDD + número, somente dígitos (12 ou 13 caracteres).

O vínculo é o comprador de uma conta (bills) da comanda, dentro do restaurante autorizado. A busca por telefone normaliza a formatação armazenada e inclui todos os registros de comprador com aquele número; não aceita trechos do telefone. Se ambos os filtros forem enviados, devem corresponder ao mesmo comprador. Comandas compartilhadas mantêm todas as contas e itens na resposta.

Esses filtros podem ser combinados com período, marca, entregador, desconto e cupom usando AND. A filtragem ocorre antes da paginação; mantenha todos os filtros ao seguir pagination.next. Nenhum resultado produz uma lista vazia.

O período continua obrigatório. A V1 mantém o limite de três dias; para buscar histórico maior, use V2 ou MCP e percorra todas as páginas.

{
  "start_date": "2026-01-01",
  "end_date": "2026-11-06",
  "buyer_phone": "5527999990000",
  "limit": 50
}

On this page