Einführung
Was die BackResto Partner-API heute bereitstellt, was sie bewusst nicht bereitstellt und wer darüber entscheidet.
BackResto ist die HACCP-Compliance-App, die Teams in der Gastronomie während des Betriebs ausfüllen: Wareneingangskontrollen, Gar- und Kühltemperaturen, Reinigungspläne, Etiketten. Die Partner-API übergibt diese Aufzeichnungen an die Software, die Ihre Kunden ohnehin schon betreiben: ein ERP, ein Lieferantenportal, ein Qualitäts-Dashboard, einen KI-Assistenten.
Es ist eine nur lesende HTTP-API mit einem Authentifizierungsverfahren und einer
Fehlerstruktur, von Anfang bis Ende beschrieben durch ein
OpenAPI-Dokument, das Sie direkt in
einen Client-Generator oder in eine LLM-Tool-Definition laden können. Dieselben
Daten sind über MCP unter https://api.backresto.com/mcp
erreichbar, mit demselben Schlüssel und denselben Rechten, wenn Sie lieber
Fragen stellen als einen Client schreiben wollen.
Das Restaurant entscheidet, was Sie sehen
Das ist der Teil, den man zweimal lesen sollte, weil er sich von den meisten APIs unterscheidet, die Sie integrieren werden.
Es gibt keine Registrierung. Ein Schlüssel wird von Hand ausgestellt, begrenzt auf benannte Restaurants und benannte Scopes, und erst dann, wenn die betreffenden Restaurants zugestimmt haben. Fragen Sie per E-Mail nach einem (Einen Schlüssel erhalten ist die Checkliste), und er trifft bei dem technischen Kontakt ein, den Sie nennen.
Die Folge ist eine harte: Ein Schlüssel erreicht die Restaurants, für die er
zugewiesen wurde, und nichts sonst. restaurant-3 taucht nicht auf, weil
restaurant-1 und restaurant-2 auf demselben Schlüssel liegen, und keine
Anfrage, die Sie stellen können, erweitert das. Einen Standort hinzuzufügen ist
ein weiteres Gespräch, mit den Leuten, deren Daten es sind.
Der Vorteil eines kleinen manuellen Schritts ist, dass der Widerruf ebenso direkt ist: eine E-Mail, und der Schlüssel ist bei der nächsten Anfrage tot.
Was in den Daten steckt
| Ressource | Was sie ist |
|---|---|
| Lieferungen | Zwei Collections: ein Datensatz pro Wareneingangskontrolle (Lieferant, Compliance-Urteil, Gründe für Abweichungen, Korrekturmaßnahmen, Freitextkommentar, eine Temperaturmessung pro Produkt, immer in Celsius) und die bei der Warenannahme aufgenommenen Fotos. |
| Collections & Datensätze | Vierundzwanzig weitere Datensatztypen, die sich einen Umschlag teilen und nach Themengebiet dokumentiert sind: Temperaturen, Kühlen und Lebensmittelprozesse, Reinigung, Fritteusen, Oberflächenanalysen, Rückverfolgbarkeitsetiketten, Dokumente, Katalog und die Standorte und Personen dahinter. |
Alles davon ist nur lesend. Nichts, was ein Partnerschlüssel aufrufen kann, schreibt in die Aufzeichnungen eines Restaurants: Die App ist der Ort, an dem Compliance-Daten entstehen, durch die Person, die dafür geradesteht.
Was hier noch nicht ist
Über die Ränder deutlich zu sein, spart Ihnen einen Nachmittag:
- Kein historischer Backfill. Die Datensätze eines Restaurants werden für diese API ab dem Moment sichtbar, in dem die Erfassung für dieses Restaurant eingeschaltet wird. Was davor war, liegt in der App, nicht hier, außer bei Lieferungen, die die Historie tragen, die die App noch hielt. Nehmen Sie einen leeren Durchlauf nicht als Beweis, dass nichts passiert ist (siehe Support).
- Keine Schreibzugriffe, keine Webhooks. Sie fragen ab. Wenn Sie Push brauchen, sagen Sie es uns; das ist eine Frage der Nachfrage, nicht des Prinzips.
- Kein inkrementeller Cursor auf Collections. Eine Collection aufzufrischen
heißt, sie erneut zu durchlaufen und über
idabzugleichen. - Keine Anmeldung mit einem BackResto-Konto. Der Partnerschlüssel bleibt der Zugangsnachweis. MCP-Clients, die nur eine URL abfragen, etwa Claude und ChatGPT, können sich über OAuth verbinden: Auf einer BackResto-Seite fügen Sie den Schlüssel ein. Es gelten weiterhin dessen Berechtigungen.
Basis-URLs
| Umgebung | Origin |
|---|---|
| Produktion | https://api.backresto.com |
| Vorproduktion | https://api-preprod.backresto.com |
| Entwicklung | https://api-dev.backresto.com |
Ein Schlüssel wird in einer Umgebung eingerichtet und bedeutet in den anderen nichts: Schlüssel, Zuweisungen und Daten gelten pro Umgebung. Alles Folgende verwendet den Produktions-Origin.
Bereit? Machen Sie Ihren ersten Aufruf.