Introdução

O BackResto é a aplicação de conformidade HACCP que as equipas de restauração preenchem durante o serviço: controlos de receção, temperaturas de confeção e de arrefecimento, planos de limpeza, etiquetas. A API de Parceiros entrega esse registo ao software que os seus clientes já utilizam — um ERP, um portal de fornecedores, um painel de qualidade, um assistente de IA.

É uma API HTTP só de leitura, com um esquema de autenticação e um formato de erro, descrita de ponta a ponta por um documento OpenAPI que pode carregar diretamente num gerador de clientes ou numa definição de ferramenta para um LLM. Os mesmos dados estão acessíveis por MCP em https://api.backresto.com/mcp, com a mesma chave e as mesmas permissões, se o que quer é fazer perguntas em vez de escrever um cliente.

O restaurante decide o que vê

Esta é a parte que vale a pena ler duas vezes, porque é diferente da maioria das API com que irá integrar.

Não há inscrição. Uma chave é emitida manualmente, limitada a restaurantes nomeados e a âmbitos nomeados, e apenas depois de os restaurantes em questão terem concordado. Peça uma por email — Obter uma chave é a lista de verificação — e ela chega ao contacto técnico que indicar.

A consequência é firme: uma chave alcança os restaurantes que lhe foram concedidos e mais nada. O restaurant-3 não aparece só porque o restaurant-1 e o restaurant-2 estão na mesma chave, e nenhum pedido que possa fazer alarga isso. Acrescentar um estabelecimento é outra conversa, com as pessoas a quem os dados pertencem.

A vantagem de um pequeno passo manual é que a revogação é igualmente direta: um email e a chave está morta no pedido seguinte.

O que está nos dados

As entregas são um recurso desenhado; as coleções entregam-lhe o registo tal como a aplicação o guarda, num único envelope genérico. O segundo caso é a forma de um módulo chegar a esta API na semana em que é lançado, em vez de no trimestre seguinte.

Tudo isto é só de leitura. Nada que uma chave de parceiro possa chamar escreve nos registos de um restaurante — a aplicação é onde os dados de conformidade são criados, pela pessoa que responde por eles.

O que ainda não está aqui

Ser explícito quanto aos limites poupa-lhe uma tarde:

• Sem recuperação de histórico. Os registos de um restaurante tornam-se visíveis para esta API a partir do momento em que a captura é ativada para esse restaurante. O que veio antes está na aplicação, não aqui. Não trate um intervalo vazio como prova de que nada aconteceu — veja Suporte.
• Sem escritas, sem webhooks. Você consulta. Se precisa de receber notificações, diga-nos; é uma questão de procura, não de princípio.
• Sem cursor incremental nas coleções. Atualizar uma coleção significa voltar a percorrê-la e reconciliar pelo id. As entregas, que são imutáveis, recebem em vez disso um intervalo de tempo.
• Sem início de sessão OAuth. Todos os clientes se autenticam com uma chave, incluindo por MCP. As ferramentas que insistem numa página de início de sessão ainda não se conseguem ligar.

URL de base

Uma chave é criada num ambiente e não significa nada nos outros: as chaves, as concessões e os dados são por ambiente. Tudo o que se segue usa a origem de produção.

Pronto? Faça a sua primeira chamada.