Skip to main content

REST-API-Schnittstellen einrichten

Bei dem Begriff REST-API handelt es sich um eine Zusammensetzung aus zwei Akronymen. Dabei steht REST für Representational State Transfer (dt. etwa: repräsentative Zustandsübertragung) und API für application programming interface, eine Schnittstelle zwischen zwei Systemen. Allgemein gesagt ermöglicht diese Schnittstelle externen Aufrufen, Daten an das plentymarkets System zu senden oder Daten von dem System abzurufen. Beispielsweise könnten dadurch also alle Kontakte aus der Kontaktlisten auf einmal abgerufen werden.

Auch in manchen Plugins, etwa eBay OAuth2 und Etsy, werden sogenannte REST-Routen verwendet, um mit dem plentymarkets System zu kommunizieren. Um dies zu ermöglichen, müssen bestimmte Berechtigungen vergeben werden.

1. Für Endanwender

Sollen Plugins mit REST-Routen im System eingebunden werden, muss diesen Plugins über einen Benutzer mit dem Zugang Backend ermöglicht werden, auf Teile des plentymarkets Systems zuzugreifen.

Benutzerkonto mit Backend-Zugang erstellen:

  1. Öffnen Sie das Menü System » Systemeinstellungen » Einstellungen » Benutzer » Konten.

  2. Klicken Sie auf Neu.
    → Das Fenster Neuen Benutzer anlegen wird geöffnet.

  3. Geben Sie den Benutzernamen ein.

  4. Geben Sie den realen Namen ein.

  5. Geben Sie das Passwort ein.

  6. Wiederholen Sie das Passwort.

  7. Geben Sie die E-Mail-Adresse der Person ein, damit sie Benachrichtigungen des Systems empfängt.

  8. Wählen Sie Backend als Benutzerzugang.

  9. Speichern Sie die Einstellungen.

Der Benutzername darf kein Leerzeichen enthalten und muss mindestens 5 Zeichen lang sein.

Im Tab Rechte legen Sie fest, welche Berechtigungen ein Benutzerkonto mit Backend-Zugang für die REST-API erhält. Standardmäßig sind keine REST-API-Berechtigungen vergeben. Berechtigungen werden für die verschiedenen Module und Submodule der REST-API separat vergeben. Unter Autorisierung legen Sie zum Beispiel fest, ob REST-API-Benutzerkonten Berechtigungen anzeigen bzw. Benutzerrollen anzeigen, erstellen und löschen dürfen.

Welche Rechte ein Plugin benötigt, ist in der Beschreibung des jeweiligen Plugins vermerkt.

REST-API-Bereiche freischalten:

  1. Öffnen Sie das Menü System » Systemeinstellungen » Einstellungen » Benutzer » Rechte » Benutzer.
    → Die Übersicht wird geöffnet.

  2. Wählen Sie einen Benutzer.
    → Der Menüpunkt Rechte mit den Sichtbarkeiten wird geöffnet.

  3. Vergeben Sie die Rechte für den jeweiligen Bereich durch Anklicken der Checkboxen. Aktivieren Sie komplette Bereiche oder klappen Sie Bereiche auf, um einzelne Berechtigungen zu aktivieren, die dem Benutzerkonto zur Verfügung stehen sollen.

  4. Speichern Sie die Einstellungen.

Hinweis: Die Bereiche Berechtigungen und Menü-Sichtbarkeiten sind verknüpft, wodurch die gewählten Rechte für den jeweils anderen Bereich automatisch mit aktiviert werden.

2. Für Entwickler

Entwicklerseite

Die Entwicklerseite ist nur auf Englisch verfügbar.

Wenn Sie ein Plugin erstellen und vermarkten möchten, das REST-Routen verwendet, können Sie dies kostenfrei über plentyMarketplace tun. Neben plentymarkets Plugins können hier auch Einträge zu externen Angeboten integriert werden. Registrieren Sie sich hier als Partner.

Allgemeine Informationen zur plentymarkets REST-API finden Sie auf unserer Entwicklerseite. Dort gibt es auch eine Übersicht der verfügbaren Routen und verschiedene Anwendungsbeispiele in Form von Tutorials:

Zum Seitenanfang