REST-API
REST-API: Ihr Upsellr-Katalog, gesteuert aus Ihren eigenen Tools.
Legen Sie Produkte aus Ihrem ERP an, laden Sie Ihre Lieferantendateien hoch, starten Sie Anreicherung und Generierung und lesen Sie anschließend die Inhalte, die für jeden Kanal und jede Sprache verfasst wurden. Eine dokumentierte REST-API, mit Schlüsseln mit begrenzten Rechten.
- Kategorie
- API
- Richtung
- Lesen und Schreiben
- Version
- REST v2, OpenAPI-Spezifikation
- Schlüssel
- Bis zu 10 pro Organisation, Rechte frei wählbar
- Sprachen
- Bezeichnungen auf Französisch, Englisch, Spanisch und Deutsch
- Authentifizierung
- API-Schlüssel im Authorization-Header
- Pläne
- Plan Enterprise
- Anbieter
- Upsellr
01Was die API kann
Upsellr, aus Ihren eigenen Tools.
- 01
Produkte stapelweise anlegen
Senden Sie bis zu 100 Produkte pro Aufruf. Upsellr erkennt sie an EAN, SKU oder Herstellerreferenz und Marke: Ein bereits bekanntes Produkt wird nicht dupliziert, es erhält eine neue Version, wenn sich ein Wert ändert.
- 02
Ihre master data lesen
Felder, Wertelisten, Kategorien und Vorlagen: Was Ihren Katalog strukturiert, lässt sich über die API lesen, mit Bezeichnungen in Ihrer Sprache.
- 03
Lieferantendateien hochladen
Legen Sie Ihre Tabellen und PDFs in der Dateibibliothek von Upsellr ab: bis zu 10 MiB in einem Upload, darüber hinaus in mehreren Teilen.
- 04
Anreicherung und Generierung starten
Starten Sie einen Lauf für eine Auswahl, eine Suche oder den gesamten Katalog, bis zu 50.000 Produkte: Lily reichert die master data an, Max schreibt die Seiten Ihrer Kanäle, oder einer Ihrer Workflows wird ausgeführt.
- 05
Generierte Inhalte lesen
Jedes Produkt liefert seine master data, seine importierten Werte und seine generierten Inhalte, geordnet nach Kanal und Sprache.
- 06
Läufe verfolgen
Ein Lauf lässt sich über die API oder per Webhook verfolgen: Ob abgeschlossen, fehlgeschlagen oder gestoppt, Ihr Tool wird benachrichtigt.
02Erste Schritte
Ihre erste Anfrage in wenigen Minuten.
- 01
Öffnen Sie die Organisationseinstellungen
Bereich API und Webhooks, Inhabern und Administratoren vorbehalten.
- 02
Erstellen Sie einen Schlüssel
Wählen Sie seine Rechte: nur Lesen, Lesen und Schreiben oder Vollzugriff. Fügen Sie bei Bedarf ein Ablaufdatum und zugelassene IP-Adressen hinzu.
- 03
Binden Sie ihn in Ihr Tool ein
Er wird bei jedem Aufruf im Authorization-Header mitgesendet.
- 04
Rufen Sie die API von Ihrem Server auf
Sie wird nicht aus einem Browser aufgerufen: Ihre Schlüssel bleiben auf dem Server.
- 05
Verfolgen Sie Ihre Läufe
Über die API oder mit einem Webhook, der Sie am Ende jedes Laufs benachrichtigt.
03Ressourcen
Was die API lesen und schreiben kann.
| Ressource | Lesen | Schreiben |
|---|---|---|
| Produkte | Ja | Ja |
| EAN, SKU und Herstellerreferenz | Ja | Ja |
| Werte der master data | Ja | Ja |
| Generierte Inhalte, nach Kanal und Sprache | Ja | Nein |
| Felder und Listen der master data | Ja | Nein |
| Quelldateien | Ja | JaBis zu 10 MiB oder in mehreren Teilen |
| Anreicherungs- und Generierungsläufe | Ja | Ja |
| Preis |
Kompatibilität und Voraussetzungen
- Der Plan Enterprise
- Eine Inhaber- oder Administratorrolle zum Erstellen der Schlüssel
- Ein Server, der die API aufruft, niemals ein Browser
- Der Header Authorization: Bearer bei jedem Aufruf
- Tipp: ein Schlüssel pro Tool, nur mit den nötigen Rechten
Sie behalten die Kontrolle
Schlüssel unter Kontrolle.
- Rechte pro Schlüssel: nur Lesen, Lesen und Schreiben oder Vollzugriff
- Ein Ablaufdatum und zugelassene IP-Adressen, wenn Sie möchten
- Aufruflimits pro Organisation, mit Hinweis bei Überschreitung
- Eine Anfrage-ID in jeder Antwort, für den Support
04Fragen
Fragen zur Upsellr-API.
Ist die API in meinem Plan enthalten?
Sie ist dem Plan Enterprise vorbehalten. In den anderen Plänen ist der Bereich API und Webhooks sichtbar, aber gesperrt.
Wo finde ich die Dokumentation?
Die API-Referenz wird aus ihrer OpenAPI-Spezifikation generiert, mit Beispielen in curl, JavaScript, Python und Ruby.
Welche Aufruflimits gelten?
Pro Organisation: 200 Lese- und 60 Schreibaufrufe pro Minute sowie 20 pro Minute für aufwendige Vorgänge wie das Anlegen von Produkten, das Hochladen von Dateien und das Starten von Läufen. Darüber hinaus antwortet die API mit 429 und der einzuhaltenden Wartezeit.
Kann ich ein Produkt über die API ändern oder löschen?
Noch nicht. Sie legen Produkte an, und ein erneut gesendetes bestehendes Produkt erhält eine neue Version, wenn sich ein Wert ändert. Änderungen und Löschungen erfolgen in Upsellr.
Wie vermeide ich Duplikate?
Upsellr erkennt jedes Produkt an seiner EAN, seiner SKU oder seiner Herstellerreferenz und Marke: Wird dasselbe Produkt erneut gesendet, entsteht kein Duplikat.
Kann ich die Anreicherung aus meinem Tool starten?
Ja. Starten Sie die Anreicherung, die Generierung, beides oder einen Ihrer Workflows, für eine Auswahl, eine Suche oder den gesamten Katalog, bis zu 50.000 Produkte pro Lauf.
Woran erkenne ich, dass ein Lauf beendet ist?
Fragen Sie den Lauf über die API ab, oder erhalten Sie einen Webhook, wenn er abgeschlossen wird, fehlschlägt oder gestoppt wird.
Gibt es ein SDK?
Derzeit nicht: Die API ist eine klassische REST-API, und die Referenz liefert Beispiele zum direkten Kopieren.
Ihr nächstes Produkt
verdient mehr als Copy-and-paste.
Geben Sie Ihrem KI-Team seine ersten Produkte.
Marcus
Amazon