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 PlentyONE System zu senden oder Daten von dem System abzurufen. Beispielsweise könnten dadurch also alle Kontakte aus der Kontaktliste auf einmal abgerufen werden.

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

1. Für Endanwender:innen

Sollen Plugins mit REST-Routen im System eingebunden werden, muss diesen Plugins über ein Benutzerkonto mit einer Rolle ermöglicht werden, auf Teile des PlentyONE Systems zuzugreifen.

Benutzer:innen-Konto ohne PlentyONE Konto-Verknüpfung erstellen:

  1. Öffne das Menü Einrichtung » Kontoverwaltung » Konten.

  2. Klicke auf add Neues Konto.

  3. Gib den Benutzer ein.

  4. Gib unter Name den realen Namen der Person ein.

  5. Gib das Passwort ein.

  6. Wiederhole das Passwort.

  7. Wähle Nur API-Benutzer unter Rechte.

  8. Wähle eine Rolle aus dem Dropdown-Menü.

  9. Speichere (save) die Einstellungen.

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

Im erweiterten Modus der Rollen-Detailansicht legst du fest, welche Berechtigungen ein Benutzerkonto 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 Authorisierung legst du 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.

Rechte an eine Rolle vergeben:

  1. Öffne das Menü Einrichtung » Kontoverwaltung » Rollen.
    → Die Übersicht wird geöffnet.

  2. Wähle ein Rolle.
    → Die Rollen-Detailansicht wird geöffnet.

  3. Vergib die Rechte in dem jeweiligen Bereich durch Anklicken der Checkboxen. Aktiviere komplette Bereiche oder klappe Bereiche auf, um einzelne Berechtigungen zu aktivieren, die der Rolle zugewiesen werden sollen.

  4. Speichere die Einstellungen.

2. Für Entwickler:innen

Entwicklerseite

Die Entwicklerseite ist nur auf Englisch verfügbar.

Wenn du ein Plugin erstellen und vermarkten möchtest, das REST-Routen verwendet, kannst du dies kostenfrei über plentyMarketplace tun. Neben PlentyONE Plugins können hier auch Einträge zu externen Angeboten integriert werden. Registriere dich hier als Partner.

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