REST-API-Zugang

Bei modified eCommerce 3.x meldet sich OBS nicht mit einem Shop-Benutzerkonto am Shop an, sondern mit einem eigenen REST-API-Zugang. Den Zugang legen Sie im Adminbereich des Shops an. Kennung und Schlüssel des Zugangs tragen Sie danach in der Konfiguration der Schnittstelle in OBS ein.

HINWEIS: modified eCommerce 3.x befindet sich in der Erprobung. Die Funktionen stehen nur für Schnittstellen zur Verfügung, die der OBS-Support dafür freigeschaltet hat. Die Beschreibung der Einstellungen im Shop entspricht dem Stand dieser Erprobungsversion.

Voraussetzungen

Im Shop ist das OBS-Modul für 3.x installiert. Das übernimmt der OBS-Support.
Sie haben ein Konto für den Adminbereich des Shops, das die Seite OBS API-Zugänge öffnen darf. Nach der Installation darf das nur das Hauptkonto des Adminbereichs. Brauchen Sie selbst Zugriff, sprechen Sie den OBS-Support an.
Die Schnittstelle ist in OBS als modified eCommerce 3.x angelegt, siehe Einrichtung.
Für die Einstellungen in OBS brauchen Sie Level 5 für die Shop-Schnittstellen.

Vorgehen

Zugang im Shop anlegen

Melden Sie sich im Adminbereich des Shops an.
Wählen Sie Konfiguration 2 → OBS API-Zugänge.
Legen Sie einen neuen Zugang an. Geben Sie ihm einen Namen, an dem Sie ihn später erkennen, z.B. OBS.
Wählen Sie die Bereiche, auf die OBS zugreifen darf. Für alle Übertragungen braucht OBS die Bereiche catalog:*, images:write, stock:write, pricelists:*, customers:* und orders:*. Mit Alle Bereiche (*) erhält der Zugang alle Bereiche außer bulk:delete.
Lassen Sie die erlaubten IP-Adressen leer, wenn Sie den Zugang nicht einschränken wollen. Tragen Sie dort nur Adressen ein, von denen OBS auf den Shop zugreift. Von allen anderen Adressen lehnt der Shop die Anmeldung ab.
Speichern Sie den Zugang. Der Shop zeigt den Schlüssel an. Kopieren Sie ihn sofort: Er wird nur dieses eine Mal angezeigt.
Notieren Sie außerdem die Kennung des Zugangs. Die Kennung ist eine Nummer.

ACHTUNG: Der Schlüssel öffnet den Zugriff auf die Daten Ihres Shops. Geben Sie ihn nur an Personen weiter, die ihn in OBS eintragen, und bewahren Sie ihn nicht ungeschützt auf. Den Bereich bulk:delete für Massenlöschungen, z.B. aller Artikel, vergeben Sie nur nach Absprache mit dem OBS-Support.

Zugang in OBS eintragen

Öffnen Sie Stammdaten → Schnittstellen → Internet-Shop, markieren Sie die Schnittstelle, drücken Sie F10 und wählen Sie X Konfiguration.
Tragen Sie in Allgemein.Shop.Api.Id die Kennung des Zugangs ein.
Tragen Sie in Allgemein.Shop.Api.Key den Schlüssel ein. OBS speichert ihn verschlüsselt und zeigt ihn in der Liste als *****.
Prüfen Sie, dass in Allgemein.Shop.URL die Adresse der Shop-Hauptseite mit https:// steht.
Drücken Sie F9, um die Verbindung zu prüfen.

Alle Einstellungen beschreibt Konfiguration.

Ergebnis

F9 in der Konfiguration meldet „Verbindung erfolgreich.“ und zeigt Basis-Version modified, API-Version und REST-API-Version.
In der Liste der Zugänge im Shop steht beim Zugang, wann er zuletzt benutzt wurde.

Wenn es nicht klappt

Die genaue Ursache steht im Protokoll der Schnittstelle (Shop-Menü Z Protokoll, Einträge mit Level 9). Weitere Meldungen stehen unter Einrichtung.

Meldung	Ursache
„Verbindung konnte nicht aufgebaut werden.“ (F9 in der Konfiguration)	`Allgemein.Shop.Api.Id`, `Allgemein.Shop.Api.Key` oder `Allgemein.Shop.URL` ist leer, oder der Shop hat die Anmeldung abgelehnt. Sehen Sie im Protokoll nach.
Protokoll: „REST-API HTTP 401 Fehler 401900: Anmeldung fehlgeschlagen“	Mögliche Ursachen: Kennung oder Schlüssel stimmen nicht. Prüfen Sie die Werte in der Konfiguration. Der Zugang ist im Shop gesperrt oder abgelaufen. Der Zugang lässt nur bestimmte IP-Adressen zu, und OBS greift von einer anderen Adresse zu.
Der Schlüssel ist nicht mehr bekannt.	Der Shop zeigt den Schlüssel nur beim Anlegen an. Legen Sie einen neuen Zugang an und tragen Sie ihn in OBS ein. Sperren Sie danach den alten Zugang.
Aufgabe „Shop <Nummer>: Bereiche des REST-API-Zugangs fehlen“	Dem Zugang fehlen Bereiche für Übertragungen, die OBS nutzt. Die Aufgabe nennt die betroffenen Aktionen und Bereiche. Ergänzen Sie die Bereiche beim Zugang im Shop. Bis dahin überspringt OBS diese Übertragungen.

Siehe auch