Einen Schlüssel erhalten
Wie Sie einen Partner-API-Schlüssel anfragen, was in die Anfrage gehört und was zurückkommt.
Partnerschlüssel werden von Hand ausgestellt. Füllen Sie das Formular unten aus — oder schreiben Sie uns eine E-Mail, die dieselben Leute erreicht — und wir richten die Zugangsdaten ein und senden sie an den Kontakt, den Sie nennen.
Jede Anfrage liest ein Mensch, denn ein Schlüssel trägt Zugriff auf die Compliance-Aufzeichnungen eines Restaurants, und das Restaurant muss dem zugestimmt haben. Das kostet Sie eine Antwort statt einer Weiterleitung; dafür kann sich niemand selbst Zugriff auf die Daten eines anderen ausstellen. Das Formular fragt alles ab, was wir brauchen, um in einem Zug zu handeln.
Wer anfragen kann
Beide Seiten, aber das Restaurant muss so oder so zustimmen.
- Sie, der Integrator. Nennen Sie die Restaurants, die Sie brauchen, und Ihren Ansprechpartner dort; wir stimmen uns mit ihm ab, bevor wir etwas ausstellen.
- Das Restaurant. Es fragt in Ihrem Namen an und nennt Sie. Das ist der schnellere Weg, weil die Bestätigung schon erfolgt ist.
Wir stellen keinen Schlüssel für ein Restaurant aus, das dem nicht zugestimmt hat, und wir erweitern einen bestehenden Schlüssel nicht, ohne erneut zu fragen.
Einen Schlüssel anfragen
Wenn Sie für mehrere Restaurants integrieren, die zu verschiedenen Kunden gehören, senden Sie eine Anfrage pro Kunde. Ein Schlüssel pro Kunde verhindert, dass ein Widerruf jede andere Integration mitreißt, die Sie betreiben.
Zwei der Felder verdienen eine Anmerkung. Die Umgebung zählt, weil Schlüssel und Daten pro Umgebung gelten — ein Produktionsschlüssel bedeutet in der Vorproduktion nichts, sagen Sie also, wenn Sie zuerst gegen die Vorproduktion entwickeln wollen. Und bei den Berechtigungen sollte stehen, was Sie nutzen, und nicht alles: Es gibt sechsundzwanzig davon, eine pro Collection plus Lieferungen und deren Fotos, und das Restaurant liest diese Liste, bevor es ihr zustimmt. Die vier zu nennen, die Sie brauchen, bringt schneller ein Ja als nach allen zu fragen; unter Authentifizierung steht, was jede einzelne öffnet.
Sie haben schon einen Schlüssel und wollen eine Collection, die er nicht erreicht? Das ist dieselbe E-Mail, und es ist eine Erweiterung und kein neuer Schlüssel: Ihr Secret ändert sich nicht und nichts muss neu ausgerollt werden.
Lieber selbst schreiben? contact@backresto.com mit denselben Angaben erreicht dasselbe Postfach.
Was zurückkommt
Ein einzelner Wert der Form brp_<prefix>.<secret>, gesendet an den technischen
Kontakt, den Sie genannt haben.
Speichern Sie ihn sofort nach Erhalt und löschen Sie die E-Mail. Wir behalten nur das öffentliche Präfix und einen Digest des Secrets, wir können ihn also nicht erneut senden — geht er verloren, widerrufen wir diesen Schlüssel und stellen einen neuen aus, was einen weiteren Umlauf bedeutet.
Schlüssel laufen nicht von selbst ab. Sie bleiben gültig, bis sie widerrufen werden — deshalb lautet die Antwort auf „jemand hat das Team verlassen“ ein Schlüsselwechsel und kein Schulterzucken.
Einen Schlüssel später ändern
All das ist eine E-Mail, und alles davon braucht die Zustimmung des Restaurants, wo es den Zugriff erweitert:
| Anliegen | Was passiert |
|---|---|
| Ein Restaurant oder eine Berechtigung hinzufügen | Wir erweitern den bestehenden Schlüssel. Ihr Secret ändert sich nicht und nichts muss neu ausgerollt werden. |
| Rotieren | Wir stellen zuerst einen zweiten Schlüssel aus, Sie rollen ihn aus, dann widerrufen wir den alten. Kein Zeitfenster, in dem keiner funktioniert. |
| Widerrufen | Sofort. Die nächste Anfrage mit diesem Schlüssel antwortet 401. |
| Ein zeitlich begrenzter Schlüssel | Sagen Sie es in der Anfrage — für ein einmaliges Audit oder einen Proof of Concept ist ein Schlüssel, der von selbst stirbt, sicherer als einer, an dessen Abschaltung Sie denken müssen. |
Für alles Dringende — vor allem ein geleaktes Secret — schreiben Sie an
contact@backresto.com
mit dem öffentlichen Präfix des Schlüssels (die brp_…-Hälfte vor dem Punkt)
und sagen Sie, dass es dringend ist. Senden Sie uns niemals das Secret selbst,
nicht einmal, um zu belegen, welchen Schlüssel Sie meinen.
Während Sie warten
Nichts in der Dokumentation braucht zum Lesen einen Schlüssel, und die Strukturen stehen alle auf diesen Seiten: der Lieferdatensatz, die Fotos, Collections und Datensätze, das Fehlermodell und Paginierung. Das OpenAPI-Dokument ist ebenfalls öffentlich, Sie können also einen Client generieren und dagegen entwickeln, bevor der Schlüssel eintrifft.