Introdução à V1.0 · Takeat API

A API Externa V1.0 é a nova superfície de integração da Takeat. Suas rotas de dados aceitam tokens OAuth2 de curta duração e a sessão autenticada do próprio restaurante. As rotas são versionadas sob /v1.

Nova API disponível

A V1.0 é a versão recomendada para todas as novas integrações. O API Legado será removido em breve; aplicações existentes devem seguir o guia de migração.

Base URL

https://public-api.takeat.app

Todos os caminhos desta versão usam essa origem. O endpoint de token é version-neutral (/oauth/token); os recursos de dados começam com /v1.

Escolha como conectar

A API Key e a autenticação OAuth dos apps para a Takeat Store compartilham as mesmas rotas de dados, mas não são a mesma jornada. Use API Key para uma automação controlada pelo próprio restaurante. Para um produto instalado por restaurantes diferentes, publique um app na Takeat Store e implemente OAuth Authorization Code com PKCE.

Fluxo com API Key

Crie uma chave no AI Builders

Entre em ai-builders.takeat.app, crie uma credencial tk_live_ ou tk_test_ e guarde o segredo exibido uma vez.

Troque a chave por um access token

Envie a chave como api_key para POST /oauth/token com grant_type=api_key. A resposta contém um bearer token curto e um refresh token rotativo.

Consuma a API V1.0

Envie o access token OAuth como Bearer nas chamadas a /v1. Uma interface Takeat já autenticada também pode enviar a sessão do restaurante como Bearer. Nunca envie a chave tk_ diretamente para uma rota de dados.

Com um token emitido para API Key ou OAuth, a operação exige o escopo indicado em seu contrato. Com uma sessão de restaurante, o acesso fica preso ao restaurant_id assinado no token e não depende dos escopos de integração.

Recursos disponíveis

Marcas

Marcas e identificação comercial do restaurante.

NF-e recebidas

Notas pendentes ou confirmadas e detalhes fiscais por assunto.

Cardápio publicado

Seções, produtos, preços efetivos e grupos de complementos por canal.

Sessões de comanda

Comandas, contas, pedidos, pagamentos e dados fiscais. A V1 mantém o limite de três dias; a V2 oferece páginas por cursor sem limite de dias.

Produtos e complementos

Os catálogos compatíveis com a resposta do API Legado, agora sob /v1.

Gerenciar produtos

Criação, edição e disponibilidade independente para presencial e delivery.

Métodos de pagamento

Métodos habilitados para o restaurante da credencial.

Clientes e Clube

Buyers vinculados à loja, compras Takeat e saldo no Clube, com identidade estável.

Clientes do Clube

Consulta paginada aos clientes do programa de fidelidade.

Lançamentos financeiros

Contas a pagar e receber, notas, itens, filtros e totais do período.

Escopo da primeira versão

Pedidos de entrada e webhooks ainda não fazem parte da superfície publicada. Eles serão documentados somente quando contrato, segurança e implementação estiverem disponíveis.

Próximos passos

Consulte também Gerenciar complementos para editar opções, preços, fiscal e disponibilidade, individualmente ou em lote.

A gestão de fichas técnicas usa novos contratos /v1/inventory e rotas technical-sheet de produtos/complementos. As listagens legadas de estoque continuam inalteradas.

Aplicativos para garçons

Escolha Garçom no cadastro do aplicativo para usar autorização OAuth pessoal com PKCE. O perfil do Client ID é fixo e tem cinco permissões de leitura, distintas das permissões de restaurante. As oito consultas públicas apoiam o atendimento presencial, sem alterações de pedidos, pagamentos ou configurações. A conta e a loja vêm do token; não envie restaurant_id. Consulte o guia de aplicativos para garçons e a referência separada por perfil.

Consultar avaliações

Avaliações do restaurante e do Clube: GET /v1/ratings exige ratings:read para todos os canais. Use channel=clube nesta mesma rota para filtrar as avaliações atuais do Clube integradas ao Takeat. As respostas organizam notas, comentários, critérios, nome e telefone do cliente quando disponíveis, contexto e resumo de todo o período.

Status e funcionalidades para tutoriais

GET /v1/restaurants/features exige restaurants:read no OAuth, ou sessão do próprio restaurante. Retorna o status da conta e apenas as capacidades de produto exportáveis, com available_features: [] para contas inativas. Consulte o guia de funcionalidades. A permissão deve ser adicionada explicitamente; apps existentes precisam revisar o consentimento e reconectar após a alteração de escopos.