Developers

BackResto for developers

The Partner API for a restaurant's own records, plus the free public endpoints on this site. BackResto is the HACCP compliance app for food service professionals.

Reading a restaurant’s records: the Partner API

If you are integrating with BackResto on a customer’s behalf (an ERP, a supplier portal, a quality dashboard, an AI assistant), the Partner API is what you want. It reads goods-in checks and their photographs plus twenty-four further record types: temperatures, cooling, cleaning, fryer checks, traceability labels and the rest. It is read-only, and a key is issued by hand once the restaurant has agreed to it.

Everything about it lives on the developer portal: quickstart, authentication and scopes, pagination, the error model, every record shape, and the hosted MCP server that puts the same data inside an AI client. The specification is at api.backresto.com/openapi.json.

Free endpoints on this site

BackResto also exposes a small set of free, unauthenticated HTTP endpoints here: a HACCP express audit intake, an EU allergen table generator, a markdown representation of every page for AI agents, and a health check. No API key is required, and none of them reach customer data. Need something neither surface covers? Tell us at contact@backresto.com.

The full API surface is described in the OpenAPI 3.1 specification. Every operation has a unique operationId, typed schemas and descriptions, so the spec can be loaded directly into LLM function-calling tools.

Endpoints

POST /api/haccp-audit : HACCP express audit

Register a food-service business for the free HACCP compliance express audit. Returns { "success": true, "companyId": string | null }.

curl -X POST https://www.backresto.com/api/haccp-audit \
  -H 'Content-Type: application/json' \
  -d '{
    "businessName": "Chez Test",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com",
    "establishmentType": "restaurant",
    "numberOfSites": 1
  }'

POST /api/allergen-table/parse : Allergen table generator

Extract every dish from up to 10 menu photos with a boolean flag for each of the 14 EU regulated allergens. Free, no authentication.

curl -X POST https://www.backresto.com/api/allergen-table/parse \
  -H 'Content-Type: application/json' \
  -d '{"files": [{"name": "menu.jpg", "type": "image/jpeg", "base64": "<...>"}]}'

GET /api/markdown/{path} : Any page as markdown

Markdown representation of any site page for AI agents, equivalent to requesting the page with an Accept: text/markdown header. Includes an x-markdown-tokens estimate.

curl https://www.backresto.com/api/markdown/fr/tarifs
# or, on any page URL:
curl -H 'Accept: text/markdown' https://www.backresto.com/fr/tarifs

GET /api/health : Health check

Liveness probe. Returns { "status": "ok" }.

curl https://www.backresto.com/api/health

Errors

Every endpoint returns structured JSON errors, never an HTML page:

{
  "error": "API endpoint not found.",
  "code": "not_found",
  "hint": "See the OpenAPI specification at https://www.backresto.com/openapi.json"
}

error is always present; code is a stable machine-readable identifier and hint tells you how to recover.

Machine-readable resources

  • OpenAPI 3.1 specification (/openapi.json): The complete BackResto public API surface: operation ids, typed request/response schemas, error model. Compatible with LLM function-calling formats.
  • llms.txt (/llms.txt): Plain-markdown overview of BackResto for AI agents: when to use the product, key pages, machine-readable entry points.
  • API catalog (RFC 9727) (/.well-known/api-catalog): Linkset enumerating the public API endpoints.
  • Agent skills index (/.well-known/agent-skills/index.json): Skill descriptors for the HACCP audit and allergen table APIs, with JSON Schemas for their inputs.
  • MCP server card (/.well-known/mcp/server-card.json): Model Context Protocol server description for BackResto.
  • Sitemap (/sitemap.xml): Every indexable page across the 7 locales.

Markdown for agents

Every HTML page on this site can be requested as markdown via content negotiation: send Accept: text/markdown and the response is the page's markdown representation with Vary: Accept declared. Nonexistent paths return a real HTTP 404 whose markdown body links the sitemap and key pages, so agents can recover.

Questions, rate limits, webhooks or a product API? Write to contact@backresto.com.