Documentation

The BackResto Partner API, end to end. Start with the quickstart if you already hold a key.

Getting started

What the Partner API is and how to make your first call.

Introduction

What the BackResto Partner API exposes today, what it deliberately does not, and who decides.

Getting a key

How to ask for a Partner API key, what to put in the request, and what comes back.

Quickstart

From a key to your first records and a delivery photograph in five minutes, with curl.

Core concepts

Authentication, errors, pagination and rate limits.

Authentication

Partner keys, the twenty-six scopes, what a grant means, and how to rotate without downtime.

Errors

One machine-readable problem document for every failure, and what each type means for your retry logic.

Pagination

How to walk any collection with an opaque cursor, and how to keep a copy of it up to date.

Rate limits

The per-key budget, the one header that describes it, and how to stay under it.

Resources

The endpoints, field by field.

Collections & records

The twenty-six record collections, the snapshot envelope they share, and how to walk one.

Temperatures

Fridge and cooking temperatures, taken by a person or reported by a sensor. Three collections, and what tells them apart.

Traceability labels

The secondary labels staff print and stick on a container, with the printed file attached and a group id per print run.

Deliveries

Goods-in checks and the photographs taken at reception: two collections, every field, and what they mean on the shop floor.

Cleaning

The cleaning plan, the tasks actually done and the photographs proving it. Three collections, and what a missing record does not prove.

Fryers

The fryers and their oil quality checks. Two collections, and why the measured value can be missing while the decision never is.

Cooling & food processes

Cooling, freezing, reheating and transport. Four collections recording a temperature transition, and what an unfinished one looks like.

Surface analyses

Surface swabs. What was tested, whether it passed, and the action plan when it did not.

Documents

The restaurant's own document store (certificates, procedures, reports), each record a filed file with its own media type.

Catalogue

Suppliers, products and in-house preparations, the reference lists the rest of the record points at.

Facilities & people

The site, its staff, its zones and its machines. The fixed map every temperature reading hangs off.

Agents & MCP

Connect BackResto to an AI client over MCP.

MCP server

Connect Claude, Cursor, Codex or any MCP client to a restaurant's compliance records with one URL and your API key.

Support

Versioning, limits of the current data, and how to reach us.

Support & data completeness

What the current data does and does not cover, how the API is versioned, and how to reach a human.