Documentação
A API de Parceiros do BackResto, de ponta a ponta. Comece pelo guia rápido se já tiver uma chave.
Primeiros passos
O que é a API de Parceiros e como fazer a sua primeira chamada.
Introdução
O que a API de Parceiros do BackResto expõe hoje, o que deliberadamente não expõe, e quem decide.
Obter uma chave
Como pedir uma chave da API de Parceiros, o que incluir no pedido e o que recebe de volta.
Guia rápido
De uma chave aos seus primeiros registos e a uma fotografia de entrega em cinco minutos, com curl.
Conceitos essenciais
Autenticação, erros, paginação e limites de pedidos.
Autenticação
Chaves de parceiro, os vinte e seis scopes, o que significa uma concessão, e como rodar sem interrupção.
Erros
Um documento de problema legível por máquina para cada falha, e o que cada tipo significa para a sua lógica de repetição.
Paginação
Como percorrer qualquer coleção com um cursor opaco, e como manter uma cópia dela atualizada.
Limites de pedidos
O orçamento por chave, o único cabeçalho que o descreve, e como ficar abaixo dele.
Recursos
Os endpoints, campo a campo.
Coleções e registos
As vinte e seis coleções de registos, o envelope de snapshot que partilham, e como percorrer uma.
Temperaturas
Temperaturas de frio e de confeção, medidas por uma pessoa ou comunicadas por um sensor: três coleções, e o que as distingue.
Etiquetas de rastreabilidade
As etiquetas secundárias que o pessoal imprime e cola num recipiente, com o ficheiro impresso anexado e um identificador de grupo por tiragem.
Entregas
Os controlos de receção e as fotografias tiradas na receção: duas coleções, cada campo, e o que significam no terreno.
Limpeza
O plano de limpeza, as tarefas efetivamente feitas e as fotografias que o provam. Três coleções, e o que um registo em falta não prova.
Fritadeiras
As fritadeiras e os controlos de qualidade do óleo: duas coleções, e porque é que o valor medido pode faltar quando a decisão nunca falta.
Arrefecimento e processos alimentares
Arrefecimento, congelação, reaquecimento e transporte: quatro coleções que registam uma transição de temperatura, e o aspeto de uma que não terminou.
Análises de superfície
Zaragatoas de superfície: o que foi testado, se passou, e o plano de ação quando não passou.
Documentos
O arquivo de documentos do próprio restaurante (certificados, procedimentos, relatórios), cada registo um ficheiro arquivado com o seu tipo de conteúdo.
Catálogo
Fornecedores, produtos e preparações da casa: as listas de referência para as quais o resto do registo aponta.
Instalações e pessoas
O estabelecimento, o seu pessoal, as suas zonas e as suas máquinas: o mapa fixo de que depende cada leitura de temperatura.
Agentes e MCP
Ligue o BackResto a um cliente de IA através de MCP.
Servidor MCP
Ligue o Claude, o Cursor, o Codex ou qualquer cliente MCP aos registos de conformidade de um restaurante com um URL e a sua chave de API.
Suporte
Versionamento, limites dos dados atuais e como falar connosco.
Suporte e completude dos dados
O que os dados atuais cobrem e não cobrem, como a API é versionada, e como falar com uma pessoa.