Anbindungspartner

Binden Sie das System an, das Sie ohnehin verkaufen

Sie haben eine Kasse gebaut, ein ERP, ein Zahlungsprodukt, ein Liefernetz, einen Küchenmonitor. Ihre Kunden sind Gastronomiebetriebe, und die SIDES-Betriebe unter ihnen erreichen Sie über eine einzige Anbindung statt über je ein Projekt.

Partner werden Wie das Ökosystem funktioniert

Die Passung

Eine Anbindung statt einer je Kunde

Üblicherweise hat diese Arbeit die Form eines Projekts je Betrieb: ein etwas anderer Export, eine etwas andere Feldzuordnung, eine etwas andere Person, die man anruft, wenn es bricht. Das skaliert schlecht und altert schlechter.

Gegen SIDES zu bauen ersetzt das durch eine einzige Anbindung an einen einzigen versionierten Vertrag: eine Feldzuordnung, eine Stelle, an der es bricht, eine Stelle, an der es repariert wird — statt je einer davon pro Kunde. Wächst der Plattform ein Feld zu, funktioniert Ihre Anbindung weiter. Das ist eine Regel und keine Hoffnung.

Die fünf Schritte von der Registrierung bis zum Eintrag ansehen

Die Wortmarke SIDES LABS, umgeben von Codeströmen und verbindenden Kabeln.

Wogegen Sie bauen

Ihr Ausschnitt aus dem Vertrag

Nichts davon wird je Partner ausgehandelt. Es ist dieselbe Oberfläche für unser eigenes Portal, für SIDES-interne Werkzeuge und für Sie.

OAuth 2.0, mit Berechtigungen
Ihre Anbindung meldet sich als Maschinenclient an und erhält ein kurzlebiges Zugriffstoken. Berechtigungen sind hierarchisch und nach Domäne verschachtelt; eine Berechtigung ohne :write ist nur lesend.
Gewährt, nicht angefordert
Die gewährte Berechtigung ist die Schnittmenge aus dem, was Ihr Client hält, und dem, was Sie angefordert haben. Mehr anzufordern ist kein Fehler — die Antwort sagt Ihnen, was Sie bekommen haben, lesen Sie sie also.
RFC-7807-Fehler
Jeder Fehlschlag ist ein Problem-Details-Dokument mit einem stabilen code, einer Anfragekennung und einem Dokumentationslink. Verzweigen Sie auf den Code, nie auf den Titel.
Ratenbegrenzungen, gegen die man planen kann
X-RateLimit-* -Kopfzeilen melden das Tagesbudget bei jeder gezählten Antwort. Ein 429 trägt Retry-After. Eine fehlende Kopfzeile bedeutet „nicht gezählt“ — nie „nichts mehr übrig“.
Ein veröffentlichtes Changelog
Jede API-Änderung wird angekündigt, bevor Sie ihr in der Produktion begegnen. Ergänzungen sind frei; Entfernungen brauchen eine neue Hauptversion und mindestens sechs Monate Vorlauf. Das Changelog selbst wird noch gebaut — die Zusage nicht.
Dokumentation aus der Spezifikation
Die OpenAPI-Spezifikation wird vor den Handlern geschrieben und ausgeliefert unter /api/docs. Der Dienst verweigert den Start, wenn beide auseinandergehen.

Ein Token holen

Ihr erster Aufruf

Formularkodiert nach RFC 6749. Die Antwort sagt, was Ihrem Client tatsächlich gewährt wurde.

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": "marketplace.apps" }
Brauche ich einen Client je Kunde?

Nein. Ein Maschinenclient ist an höchstens einen Geschäftspartner gebunden — Ihren. Ein Betrieb, der Ihre App einsetzt, wird nicht in Ihrem Namen zu einem Maschinenclient von uns.

Kann ein anderer Partner meine Apps oder meine Zahlen sehen?

Nein. Jede partnerbezogene Abfrage wird nach dem Geschäftspartner gefiltert, der aus dem angemeldeten Prinzipal abgeleitet ist — serverseitig, bei jeder Anfrage. Es ist kein Filter in einer Maske, den eine andere Maske vergessen könnte.

Was passiert, wenn sich die API ändert?

Felder, Endpunkte und Aufzählungswerte werden ohne Ankündigung ergänzt, und Ihr Client muss unbekannte vertragen. Alles, was Sie brechen könnte — eine Entfernung, eine Umbenennung, eine Typ- oder Bedeutungsänderung — ist eine neue Hauptversion, im Changelog mit mindestens sechs Monaten Vorlauf angekündigt.

Woran erkenne ich, wie die Anbindung läuft?

Nutzungsstatistiken, Bewertungen und Rezensionen zu Ihrem Eintrag kommen im Partnerbereich des Portals zu Ihnen zurück. Sie werden von der SIDES-Plattform stammen und nicht selbst gemeldet sein; welche API sie liefert, wird noch entschieden.

Was es heute gibt

Die Plattform wird offen gebaut, und diese Seite beschreibt die Plattform, die gebaut wird. Heute authentifiziert die API OAuth-Maschinenclients und meldet Identität, Berechtigungen und Ratenbegrenzung des aufrufenden Prinzipals. Partnerregistrierung und Anmeldung, der Marktplatzkatalog, das API-Changelog, die Entwicklerressourcen, Nutzungsstatistiken und die Tarifseiten kommen in den Phasen danach — jede Zusage oben ist eine Zusage und kein Bildschirmfoto.

Bringen Sie Ihr Produkt dorthin, wo die Betriebe schon sind

Die Registrierung legt Ihren Geschäftspartner, Ihren ersten Administrator und Ihren Tarif an. Die Freigabe zur Veröffentlichung ist ein eigener, festgehaltener Schritt.

Als Partner registrieren Sprechen Sie zuerst mit uns