Die öffentliche API nutzen
Basisadresse, Authentifizierung, Ratenlimits und Request-ID: das Wesentliche, um Ihre Tools mit Upsellr zu verbinden.
Die öffentliche API von Upsellr gibt Ihnen aus Ihren eigenen Tools Zugriff auf Ihre master data, Ihre Produkte, Ihre Quellen und Ihre Workflows. Sie ist im Tarif Enterprise enthalten.
Das Wesentliche
- Basisadresse:
https://api.upsellr.io/v2 - Authentifizierung: Jede Anfrage trägt den Header Authorization mit dem Wert Bearer, gefolgt von Ihrem Schlüssel. Siehe API-Schlüssel erstellen und verwalten.
- Dokumentation: Die vollständige Referenz mit Beispielen ist auf docs.upsellr.io veröffentlicht.
Aufrufe nur von einem Server
Die API wird von einem Server aufgerufen, nie aus einem Browser: Sie antwortet nicht auf Anfragen, die von einer Webseite gesendet werden. So vermeiden Sie auch, Ihren Schlüssel im Code einer Seite preiszugeben.
Die Ratenlimits
Die Limits gelten für die gesamte Organisation, über alle Schlüssel hinweg.
| Anfragetyp | Pro Minute | Burst |
|---|---|---|
| Lesezugriffe | 200 | 30 |
| Schreibzugriffe | 60 | 10 |
| Schwere Schreibzugriffe: Anlegen von Produkten, Ablegen einer Datei, Start eines Workflows | 20 | 5 |
| Suche und Lesen von Produkten | 60 | 5 |
Darüber hinaus antwortet die API mit dem Code 429 und einem Header Retry-After, der in Sekunden angibt, wann Sie es erneut versuchen können.
Request-ID
Jede Antwort trägt einen Header X-Request-Id. Wenn eine Anfrage unerwartet fehlschlägt, notieren Sie diese Kennung und geben Sie sie an den Support weiter: Damit lässt sich Ihr Aufruf genau wiederfinden.
Gut zu wissen
- Ein Schlüssel, der auf bestimmte IP-Adressen oder User-Agents beschränkt ist, wird von jeder anderen Herkunft abgelehnt.
- Zu viele Anfragen mit einem ungültigen Schlüssel von derselben Adresse führen zu einer vorübergehenden Sperre, angezeigt durch einen Code 429.
- Ein Schlüssel handelt nur im Rahmen seiner Berechtigungen: Eine Anfrage außerhalb davon wird abgelehnt.
- Einen Workflow über die API zu starten, verbraucht Credits wie in der App.
- Um über das Ende einer Ausführung informiert zu werden, ohne die API ständig abzufragen, verwenden Sie die Webhooks.
- Eine Frage? Nutzen Sie Kontakt oder die Schaltfläche Fehler melden in der App, mit der Request-ID.