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.

O que a API de Parceiros do BackResto expõe hoje, o que deliberadamente não expõe, e quem decide.

Como pedir uma chave da API de Parceiros, o que incluir no pedido e o que recebe de volta.

De uma chave a uma entrega e a um registo de coleção em cinco minutos, com curl.

Autenticação, erros, paginação e limites de pedidos.

Chaves de parceiro, os vinte e seis âmbitos, o que significa uma concessão, e como rodar sem interrupção.

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.

Como percorrer as entregas e os registos de uma coleção com um cursor opaco, e porque é que uma recebe um intervalo de tempo e a outra não.

O orçamento por chave, o único cabeçalho que o descreve, e como ficar abaixo dele.

Os endpoints, campo a campo.

O registo de receção de mercadorias — cada campo, o seu tipo, e o que significa no terreno.

As imagens tiradas na receção, servidas como URL assinados que expiram ao fim de quinze minutos.

Os vinte e quatro tipos de registo para além das entregas — o envelope de instantâneo que partilham, o que é um instantâneo, e como percorrer um.

Ligue o BackResto a um cliente de IA através de 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.

Versionamento, limites dos dados atuais e como falar connosco.

O que os dados atuais cobrem e não cobrem, como a API é versionada, e como falar com uma pessoa.