Documentação
Publicar na Takeat Store
Proponha um app, prepare sua apresentação e publique um app para a Takeat Store instalável por restaurantes.
A Takeat Store reúne aplicativos que um restaurante pode conhecer e conectar à própria conta. Cada app aprovado recebe um Client ID público e usa OAuth Authorization Code com PKCE; nenhum restaurante precisa compartilhar API key, senha ou sessão com o desenvolvedor.
Store e API Key são jornadas diferentes
Uma API key pertence ao restaurante que a criou e atende automações próprias.
Um app da Store pertence ao desenvolvedor e pode ser instalado, com
consentimento independente, por vários restaurantes. Os dois fluxos terminam
em um access token Bearer para as rotas /v1, mas criação, renovação,
revogação e responsabilidade pelas credenciais continuam separados.
Quando publicar um app
Use a Store quando seu produto:
- será conectado por restaurantes de empresas diferentes;
- precisa mostrar uma tela de consentimento com identidade e permissões claras;
- deve manter tokens, cache e jobs isolados por instalação;
- oferece um site ou painel próprio para o restaurante usar depois da conexão.
Para um script, ERP interno ou automação controlada por um único restaurante, use Autenticação com API Key. Não crie um app para a Takeat Store apenas para ocultar uma API key no navegador: segredos e tokens continuam sendo responsabilidade do backend.
Ciclo de publicação
Prepare a especificação
Defina a proposta de valor, os fluxos do usuário, o modelo de preço, o suporte, os callbacks exatos e somente os escopos necessários. Use os prompts para agentes para criar ou atualizar essa especificação a partir do seu projeto.
Envie a proposta no AI Builders
Entre em AI Builders, acesse a área de apps para a Takeat Store e selecione Enviar novo app. A proposta fica vinculada ao restaurante autenticado e pode ser acompanhada pelos usuários dele.
Aguarde a análise da Takeat
Enviar a proposta não cria um Client ID, não publica o app e não autoriza restaurantes. Em caso de rejeição, revise a observação e envie uma nova proposta corrigida.
Implemente e teste OAuth
Depois da aprovação, copie o Client ID e a configuração do app. No
Laboratório OAuth, valide o callback e a instalação, gere PKCE, troque
um code, renove e revogue tokens e teste as rotas /v1 permitidas.
Publique e acompanhe instalações
O restaurante encontra o app na Store, revisa as permissões e autoriza a conexão. Seu backend passa a cuidar da instalação e do refresh token rotativo. A Takeat não executa a cobrança do seu produto.
O que preparar para a proposta
| Grupo | Informação |
|---|---|
| Identidade | Nome do app, desenvolvedor ou empresa, logo e descrição curta |
| Contato | E-mail e telefone de suporte |
| Confiança | Site público e política de privacidade |
| Apresentação | README em Markdown e até 10 URLs de capturas de tela |
| Comercial | Gratuito, pagamento único, assinatura ou preço inicial; valor e período quando aplicáveis |
| OAuth | Ambiente, uma ou mais redirect URIs exatas e escopos mínimos |
O logo é obrigatório para uma proposta nova. A descrição, o README e as
capturas podem ser ajustados para explicar o produto com clareza, mas não
substituem um site e uma política de privacidade válidos. URLs de produção usam
HTTPS sem credenciais ou fragmentos. Em ambiente de teste, HTTP é aceito apenas
para loopback, como localhost.
Todos os modelos publicados oferecem sete dias de teste. Essa é uma condição comercial que o desenvolvedor deve cumprir; a Takeat Store não cria assinaturas, processa pagamentos nem aplica automaticamente o período.
Identidade, instalação e visibilidade
Estes conceitos não são equivalentes:
| Conceito | Significado |
|---|---|
| Proposta | Registro de autoria e análise enviado pelo restaurante desenvolvedor |
| App aprovado | Cliente OAuth público com Client ID, callbacks, escopos e ambiente |
| Publicação | Visibilidade do app no catálogo da Store |
| Instalação | Consentimento de um restaurante específico para um app específico |
Um app oculto pode continuar acessível a instalações existentes, mas não aparece na descoberta pública. Suspender o app ou seu parceiro impede novas autorizações e renovações. Alterar escopos invalida consentimentos e tokens existentes; cada restaurante precisa revisar a nova lista e reconectar.
O total installationCount do catálogo representa restaurantes distintos no
histórico de instalações do app. Reautorizações e registros de ambientes
diferentes do mesmo restaurante contam uma vez. Revogar o acesso não apaga esse
histórico; esse total não representa conexões ativas nem chamadas à API.
Checklist antes de enviar
- O site explica o que o app faz e como obter suporte.
- A política de privacidade descreve os dados acessados e sua retenção.
- Cada callback pertence ao ambiente correto e coincide exatamente com a implementação.
- O app não possui nem espera um
client_secret. - Os escopos correspondem a funcionalidades visíveis na proposta.
- Tokens e verifier ficam somente no backend do app.
- Cada instalação tem armazenamento, lock de refresh, cache e jobs próprios.
- A desconexão revoga tokens e interrompe tarefas futuras.
- Testes cobrem aprovação, recusa, state divergente, code expirado, refresh rotativo,
401,403e429.
Depois da aprovação
Use Ver configuração no AI Builders para copiar os endpoints e callbacks. Use Testar OAuth para executar o fluxo real sem misturá-lo ao testador de API Key. O laboratório nunca cria consentimento por conta própria: ele abre o portal oficial, e o proprietário ainda precisa entrar, revisar e decidir.
O laboratório não é a arquitetura do seu app
Para viabilizar o diagnóstico, essa ferramenta mantém code, verifier e tokens temporariamente na memória da aba autenticada. Ela não persiste nem exibe os tokens completos. Em produção, seu aplicativo deve validar o callback, trocar o code e armazenar os tokens exclusivamente no backend.
O teste pode acessar dados reais do restaurante. Ambiente test identifica a
credencial e permite callbacks locais; ele não cria um banco sandbox. Prefira
leituras, use IDs controlados e revise qualquer escrita antes de enviá-la.
Avaliações dentro do seu aplicativo
Apps com perfil Restaurante podem consultar e enviar as mesmas avaliações exibidas na Takeat Store usando o access token da conexão OAuth com PKCE:
| Método e rota | Resultado |
|---|---|
GET /v1/store/reviews?page=1 | Todas as avaliações do app conectado, da mais recente para a mais antiga |
GET /v1/store/reviews?restaurant_id=85&page=1 | Somente a avaliação do restaurante autorizado escolhido |
POST /v1/store/reviews | Cria ou atualiza a avaliação do restaurante conectado |
DELETE /v1/store/reviews/{reviewId} | Exclui a avaliação do próprio restaurante no app conectado |
O client_id do token identifica o aplicativo. Não envie client_id, o UUID
interno do app ou o autor no corpo ou na query. Essas operações da própria
Store exigem store:reviews:read para GET e store:reviews:write para POST e DELETE.
Adicione as permissões ao app e solicite novo consentimento ao restaurante; tokens
existentes não recebem escopos automaticamente. ratings:read e clube:read não
autorizam essas operações. É necessária uma instalação ativa e não
expirada, de um app visível e ativo; API keys, tokens de client credentials,
sessões humanas, MCP e autorizações de garçom não dão acesso a essas rotas.
Para solicitar uma avaliação dentro do app, deixe o restaurante escolher a nota e escrever o comentário antes de enviar:
POST /v1/store/reviews
Authorization: Bearer {access_token_da_instalacao}
Content-Type: application/json
{
"rating": 5,
"comment": "Ajudou a organizar o dia a dia do restaurante."
}A nota é um inteiro de 1 a 5. O comentário é texto simples, tem espaços nas
extremidades removidos e deve conter de 3 a 1500 caracteres. A resposta é
200 tanto na criação quanto na atualização. Há uma avaliação editável por
app e restaurante; novos envios atualizam o mesmo registro. O autor é o usuário
responsável pelo consentimento ou o dono registrado da rede, verificado no
banco. Conexões antigas ou internas sem esse usuário precisam passar novamente
pelo consentimento do responsável para enviar uma avaliação.
Para excluir, use o id retornado na avaliação:
DELETE /v1/store/reviews/{reviewId}
Authorization: Bearer {access_token_da_instalacao}A exclusão retorna 204, sem corpo, e exige que a avaliação pertença ao
próprio restaurante autorizado e ao aplicativo da conexão. Em conexões com
várias lojas, informe ?restaurant_id=85, como no envio. Avaliações de outro
restaurante ou app, inexistentes ou já excluídas retornam o mesmo 404.
A exclusão é lógica: o registro e seu conteúdo são preservados com uma data
de exclusão, mas deixam de aparecer nas consultas, no total, na média e em
ownReview, inclusive no catálogo da Takeat Store. Se o restaurante enviar
uma avaliação novamente, o mesmo registro é restaurado com a nova nota e o
novo comentário.
A listagem retorna data, pagination e meta, com 10 registros por página
e page de 1 a 1000. meta contém average, ownReview, canReview e page.
Cada avaliação inclui id, rating, comment, isExample, createdAt,
updatedAt, userName e restaurantName. Os nomes podem ser null; IDs de
contas e e-mails não são publicados. Avaliações fictícias de demonstração são
identificadas por isExample.
Sem restaurant_id, a consulta inclui todas as avaliações do app. Com o
filtro, a lista, o total e a média consideram somente aquele restaurante.
Se ele ainda não avaliou, data fica vazio, o total é zero e average e
ownReview são null. A loja precisa estar autorizada na conexão; tentar
selecionar outra retorna 403.
No envio, o restaurante é inferido quando o token autoriza uma única loja.
Se a conexão autoriza várias, use POST /v1/store/reviews?restaurant_id=85.
O consentimento aprovado e os vínculos atuais da rede limitam a seleção.
Categoria e público da vitrine
A equipe Takeat define a categoria do aplicativo e as interfaces em que ele aparece: Dashboard operacional, Gestor e Multilojas. Um aplicativo pode aparecer em mais de uma interface. Essa curadoria é separada do perfil de quem autoriza e das permissões OAuth solicitadas.
Aplicativos aprovados ainda sem categoria ou público permanecem ocultos até a publicação pela equipe Takeat. Mudar a categoria ou o público não revoga as conexões existentes. O cliente continua podendo gerenciar seu acesso em Minhas conexões ou Somente conectados, mesmo que o app saia daquela vitrine.
Continue daqui
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.