Dokumentation

Die BackResto Partner-API, von Anfang bis Ende. Beginnen Sie mit dem Schnellstart, wenn Sie bereits einen Schlüssel haben.

Erste Schritte

Was die Partner-API ist und wie Sie Ihren ersten Aufruf machen.

Einführung

Was die BackResto Partner-API heute bereitstellt, was sie bewusst nicht bereitstellt und wer darüber entscheidet.

Einen Schlüssel erhalten

Wie Sie einen Partner-API-Schlüssel anfragen, was in die Anfrage gehört und was zurückkommt.

Schnellstart

Von einem Schlüssel zu einer Lieferung und einem Collection-Datensatz in fünf Minuten, mit curl.

Kernkonzepte

Authentifizierung, Fehler, Paginierung und Ratenbegrenzungen.

Authentifizierung

Partnerschlüssel, die sechsundzwanzig Berechtigungen, was eine Zuweisung bedeutet und wie Sie ohne Ausfallzeit rotieren.

Fehler

Ein maschinenlesbares Problemdokument für jeden Fehlschlag und was jeder Typ für Ihre Retry-Logik bedeutet.

Paginierung & Zeiträume

Wie Sie Lieferungen und Collection-Datensätze mit einem undurchsichtigen Cursor durchlaufen und warum das eine einen Zeitraum nimmt und das andere nicht.

Ratenbegrenzungen

Das Budget pro Schlüssel, der eine Header, der es beschreibt, und wie Sie darunter bleiben.

Ressourcen

Die Endpunkte, Feld für Feld.

Lieferungen

Der Wareneingangsdatensatz — jedes Feld, sein Typ und was es im laufenden Betrieb bedeutet.

Lieferfotos

Die bei der Warenannahme aufgenommenen Bilder, ausgeliefert als signierte URLs, die nach fünfzehn Minuten ablaufen.

Collections & Datensätze

Die vierundzwanzig Datensatztypen neben den Lieferungen — der Snapshot-Umschlag, den sie teilen, was ein Snapshot ist und wie Sie einen durchlaufen.

Agenten & MCP

BackResto über MCP mit einem KI-Client verbinden.

MCP-Server

Claude, Cursor, Codex oder einen beliebigen MCP-Client mit einer URL und Ihrem API-Schlüssel an die Compliance-Datensätze eines Restaurants anbinden.

Support

Versionierung, Grenzen der aktuellen Daten und wie Sie uns erreichen.

Support & Datenvollständigkeit

Was die aktuellen Daten abdecken und was nicht, wie die API versioniert wird und wie Sie einen Menschen erreichen.