Ein Softwarehaus integriert die API in seine Warenwirtschaft und schaltet sie für vierzig Betriebe frei. Mit einem gemeinsamen Schlüssel entstehen sofort zwei Probleme: Ein Betrieb, der einen Stapelimport startet, bremst die anderen aus, und am Monatsende lässt sich nicht sagen, wer welchen Verbrauch verursacht hat.
Die Verwaltungsaufrufe des Hubs lösen das getrennt nach Zuständigkeit: Der Master-Client legt Zugänge an, setzt je Zugang Limits, liest je Zugang die Nutzung und kann Kosten ausdrücklich übernehmen. Die fünf Zweige sind unabhängig — man braucht nicht alle.
| Fläche | Rollen |
|---|---|
| Hub | Softwarehaus, Plattform und Marktplatz |
Was dieser Fall voraussetzt
- Ein Master-Client. Die Verwaltungsaufrufe setzen voraus, dass Ihr Zugang Unter-Nutzer führen darf.
- Eine Zuordnung im eigenen System. Die zurückgegebene
clientIdmuss bei Ihnen auf den Betrieb zeigen, sonst ist die Nutzungsauswertung wertlos. - Eine Entscheidung über das Abrechnungsmodell. Zahlt der Betrieb selbst, oder springen Sie ein? Unter einer Kostenübernahme wird zuerst aus Plan und Guthaben des Betriebs bezahlt; erst wenn beide die Anfrage nicht tragen, springt der Sponsor ein — es sei denn, Sie geben mit
partnerTermsAlloweddie Wahl frei und der Betrieb entscheidet sich für Ihre Konditionen. - Getrennte Aufbewahrung der Schlüssel. Ein Schlüssel je Betrieb nützt nur, wenn er nicht in einer gemeinsamen Konfiguration landet.
Der Ablauf
Die Tabelle nennt je Stufe den zuständigen Aufruf und das, was danach vorliegt. Die Begründung, warum die Stufe nicht übersprungen werden kann, steht darunter.
| Stufe | Aufruf | Was danach vorliegt |
|---|---|---|
| Partner freischalten | POST /client/partner-workspaces | Ein Arbeitsbereich mit Schlüssel und ausgewählten Freischaltungen |
| Unter-Nutzer anlegen | POST /client/users | Je Betrieb ein eigener Zugang mit initialem Schlüssel |
| Limits setzen | PUT /client/users/{clientId}/rate-limits | Ein einzelner Betrieb kann das Kontingent der anderen nicht aufbrauchen |
| Nutzung ablesen | GET /client/users/{clientId}/usage | Verbrauch und Guthaben je Betrieb, Grundlage der Weiterverrechnung |
| Kosten übernehmen | PUT /client/sponsorship-grants/{grantReference} | Das Softwarehaus erteilt einem Betrieb ausdrücklich eine Kostenübernahme |
Warum jede Stufe nötig ist
- Einen Partner freischalten.
POST /client/partner-workspaceslegt einen Arbeitsbereich mit Schlüssel und ausgewählten Freischaltungen an. Das ist der Weg, wenn ein Partner eigenständig arbeiten soll, statt nur ein Unterkonto zu sein. - Einen Unter-Nutzer anlegen.
POST /client/userserzeugt je Betrieb einen Zugang mit initialem Schlüssel. Weitere Schlüssel für denselben Zugang legtPOST /client/users/{clientId}/keysan; einen Aufruf zum Widerruf einzelner Schlüssel legt der Vertrag nicht fest. - Die Limits setzen.
PUT /client/users/{clientId}/rate-limitsersetzt die Limits eines Zugangs. Diese Stufe ist der eigentliche Grund für getrennte Zugänge: Sie verhindert, dass ein einzelner Stapellauf das Kontingent aller aufbraucht. - Die Nutzung ablesen.
GET /client/users/{clientId}/usagegibt Verbrauch und Guthaben je Betrieb. Das ist die Grundlage jeder Weiterverrechnung — und der einzige belastbare Weg, einem Kunden seinen Verbrauch zu erklären. - Kosten übernehmen.
PUT /client/sponsorship-grants/{grantReference}erteilt eine Kostenübernahme aktiv. Sie geschieht nie stillschweigend: Wer sie erteilt, tut es mit einem Aufruf, und der Empfänger sieht sie.
curl -X POST \
-H 'X-Api-Key: <MASTER_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{"name":"Autoverwertung Beispiel GmbH","applicationLabel":"erp-connector","rateLimits":[{"endpointKey":"vin.vehicle","windowSeconds":60,"maxRequests":120,"isActive":true}]}' \
'https://api.tapinomahub.com/client/users'Was am Ende vorliegt
Am Ende steht eine Integration, die einmal gebaut ist und sich pro Betrieb verantworten lässt: eigener Schlüssel, eigenes Limit, ablesbarer Verbrauch. Der Betrieb, der den Stapelimport startet, bremst niemanden mehr aus.
Wo das in der Dokumentation steht
Die verbindlichen Feldlisten, Fehlercodes und Beispielantworten stehen im OpenAPI-Vertrag dieser Fläche unter docs.tapinomahub.com (tapinoma-hub). Alle Anwendungsfälle nach Fläche und Rolle geordnet: Übersicht der Anwendungsfälle.
Quellen und Rechtsgrundlagen
Häufige Fragen
Wann nehme ich einen Partner-Workspace statt eines Unter-Nutzers?
Der Unter-Nutzer ist ein Zugang unter Ihrer Verwaltung. Der Partner-Workspace ist für Partner gedacht, die eigenständig arbeiten und eigene Freischaltungen tragen sollen.
Kann ich einen Schlüssel tauschen, ohne den Betrieb auszusperren?
Für einen bestehenden Zugang lässt sich über POST /client/users/{clientId}/keys ein weiterer Schlüssel anlegen. Einen Aufruf, der einen einzelnen Schlüssel widerruft, legt der Vertrag nicht fest.
Sieht der Betrieb, dass ich seine Kosten übernehme?
Ja. Erhaltene Kostenübernahmen sind für den Empfänger über GET /client/sponsorship-grants/received abrufbar; hat der Sponsor die Wahl mit partnerTermsAllowed freigegeben, wählt der Empfänger die Konditionen. Eine verdeckte Übernahme ist nicht vorgesehen.
