Öffentlich
Marktplatz und Entwicklerressourcen
Der Katalog, das API-Changelog, der Entwickler-Blog und die Preise — für jeden lesbar, indexiert und ohne eine einzige Anfrage an Dritte ausgeliefert.
Bauen Sie auf der Plattform, auf der Gastronomie läuft
SIDES ist das API-first-Backend hinter Restaurants, Filialen, Kassensystemen, Küchen, Webshops und Lieferung. SIDES LABS ist der Ort, an dem Partner dagegen bauen: registrieren, entwickeln, eine App einreichen und über den Marktplatz jeden Betrieb auf SIDES erreichen.
Für Anbindungspartner, Dienstleister und Agenturen, die auf SIDES bauen.
Worum es geht
Eine Partnerplattform, keine Partnerseite
SimplyDelivery betreibt SIDES, die Enterprise-Plattform, auf der Gastronomiebetriebe ihr Tagesgeschäft führen. SIDES LABS ist die Hälfte davon, die allen anderen gehört: der Ort, an dem sich ein Softwareunternehmen als Geschäftspartner registriert, einen Dienst gegen die SIDES API baut und ihn SIDES-Kunden anbietet.
Der gesamte Lebenszyklus liegt hier — Registrierung und Tarife, Entwicklerressourcen, das API-Changelog, Einreichung und Freigabe einer App, Präsenz im Marktplatz, Bewertungen und Nutzungsstatistiken. Ein Konto, ein Vertrag, ein Ort zum Nachsehen.
Die Plattform
Eine API, drei Zielgruppen, ein Vertrag
Alles, was das Portal kann, kann die API — dokumentiert, versioniert und berechtigungsgeprüft. Eine Funktion, die nur über unsere eigene Oberfläche funktioniert, ist ein Fehler und keine Abkürzung.
Partner
Ihre Apps, Ihre Statistiken, Ihr Team
Ein angemeldeter Bereich je Geschäftspartner: App-Einreichungen, Versionen, Bewertungen, Nutzungsstatistiken, Abrechnung und Teamverwaltung. Partnerdaten überschreiten nie eine Partnergrenze.
SIDES-intern
Tarife, Freigabe und Redaktion
Tarifverwaltung, Partnerverwaltung, App-Freigabe, Moderation, Abzeichen und Hervorhebungen — jeder Veröffentlichungsschritt ein ausdrücklicher, festgehaltener Zustandswechsel.
Wer hier baut
Drei Wege auf die Plattform
Der Weg unterscheidet sich, der Vertrag nicht. Wählen Sie die Beschreibung, die nach Ihrem Unternehmen klingt.
Anbindungspartner
Sie haben bereits ein Produkt
Eine Kasse, ein ERP, ein Zahlungsdienstleister, ein Liefernetz, ein Küchenmonitor. Sie verbinden ein bestehendes System mit SIDES und halten es synchron.
Dienstleister
Sie verkaufen Betrieben eine Dienstleistung
Auswertung, Marketing, Personal, Buchhaltung, Gästebindung. Sie bauen die Schicht, die dem einen Sinn gibt, was ein Betrieb erzeugt.
Agenturen
Sie bauen im Auftrag eines Kunden
Sie liefern Projekte für Gastronomiemarken und möchten, dass die SIDES-Anbindung eine eigene Fähigkeit ist und kein Unterauftrag.
Der Weg
Wie ein Partner liefert
Vier Schritte, in dieser Reihenfolge. Nichts erreicht einen SIDES-Kunden ohne eine ausdrückliche, festgehaltene Freigabe.
-
Das Unternehmen registrieren
Sie legen einen Geschäftspartner und seinen ersten Administrator an, wählen einen Tarif und bestätigen Ihre Adresse. Bis das bestätigt ist, ist der Partner nicht öffentlich sichtbar.
-
Zugangsdaten erhalten
Ihre Anbindung meldet sich als OAuth 2.0-Client an und erhält ein kurzlebiges Zugriffstoken mit genau den Berechtigungen, die ihr gewährt wurden.
-
Gegen die API bauen
Ein REST-Vertrag, eine Fehlerform, ein Satz Ratenbegrenzungs-Kopfzeilen. Die Spezifikation ist veröffentlicht, versioniert, und sie wird Ihnen nie unter den Füßen weggezogen.
-
Einreichen und veröffentlichen
Sie reichen eine App-Version zur Prüfung ein. SIDES gibt sie frei, und der Eintrag erscheint im Marktplatz, wo Betriebe ihn finden.
Erste Schritte
Anmelden, dann fragen, wer man ist
POST
/v1/oauth/token
curl -X POST https://api.sideslabs.com/v1/oauth/token \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode "username=$CLIENT_ID" \
--data-urlencode "password=$CLIENT_SECRET"
{ "access_token": "…", "token_type": "Bearer",
"expires_in": 3600, "scope": "publication.changelog:write" }Welche Berechtigungen bekommt mein Client?
Die Schnittmenge aus den Berechtigungen, mit denen Ihr Client konfiguriert ist, und dem, was Sie anfordern. Eine Berechtigung anzufordern, die Ihr Client nicht hat, ist kein Fehler — die Antwort sagt Ihnen, was tatsächlich gewährt wurde, lesen Sie also
scope aus der Antwort, statt Ihre Anfrage zu unterstellen.
Wie sehen Fehler aus?
RFC 7807 Problem Details, mit einem stabilen code , auf den Clients verzweigen. Verzweigen Sie nie auf den Titel oder allein auf den Status.
Kann ich mich schon als Partnernutzer anmelden?
Noch nicht. Phase 1 authentifiziert OAuth-Maschinenclients. Registrierung und Anmeldung von Partnernutzern folgen in Phase 2.
SIDES-Partner werden
Die Registrierung legt Ihren Geschäftspartner, Ihren ersten Administrator und Ihren Tarif an. Sie dauert Minuten; die Freigabe ist ein eigener, festgehaltener Schritt.