Einführung in Integrations-Anmeldedaten
Updated
durch
Victor Jespersen
Erste Schritte
Um mit der Quinyx REST API zu beginnen, gibt es einige Dinge, die Sie wissen müssen.
Das für Autorisierungen der REST APIs verwendete Framework ist OAuth2. Weitere detaillierte Informationen finden Sie hier https://oauth.net/2/
Anmeldedaten
Der grundlegende Ablauf für die Authentifizierung besteht darin, dass einem Benutzer ein Satz von Anmeldedaten zugewiesen wird, die mit einer UUID identifiziert werden:
- uuid - dies ist ein Bezeichner für den Satz von Anmeldedaten. Dies sollte bei Bedarf in der Kommunikation mit dem Quinyx-Support verwendet werden.
- Client ID - bewahren Sie diese an einem sicheren Ort auf. Kann geteilt werden, wird normalerweise als Benutzername in Anwendungen wie Postman oder ähnlich verwendet.
- Client secret - muss SEHR vertraulich behandelt werden, dies ist das Passwort und gibt dem Besitzer in Kombination mit der Client ID Zugriff auf die definierten Scopes.
Scopes und Berechtigungen
Scopes | Scope bestimmt, auf welche „Gruppe" von Funktionen Sie über die API zugreifen können. Version 2 Anmeldedaten:
Version 3 Anmeldedaten:
|
Berechtigungen  | Berechtigungen bestimmen, was Sie mit der Funktionalität tun können, auf die Sie Zugriff haben. Lesen - GET Hinzufügen - POST Schreiben - PUT, PATCH Löschen - DELETE |
Anmeldedaten generieren
- Klicken Sie auf Kontoeinstellungen.
- Unter Zugriffsrechte klicken Sie auf Integrations Anmeldedaten. Falls Anmeldedaten vorhanden sind, werden diese hier angezeigt und Sie können Namen und Beschreibungen der vorhandenen Anmeldedaten bearbeiten. Sie können auch einsehen, welche Bereiche und Berechtigungen für jeden Satz von Anmeldedaten festgelegt sind.
- Um einen neuen Satz von Anmeldedaten zu erstellen, klicken Sie auf Anmeldedaten generieren.
Name (erforderlich) | Geben Sie den Namen dieses Satzes von Anmeldedaten ein. Dies kann zu einem späteren Zeitpunkt bearbeitet werden, ist aber ein erforderliches Feld. |
Beschreibung (erforderlich) | Geben Sie eine Beschreibung für diesen Satz von Anmeldedaten ein. Dies kann zu einem späteren Zeitpunkt bearbeitet werden, ist aber ein erforderliches Feld. |
Version | Wählen Sie zwischen Version 2 und Version 3 Bereiche. |
Bereiche und Berechtigungen | Wählen Sie die Bereiche und Berechtigungen aus, die die Anmeldedaten haben sollen Lesen - GET , Hinzufügen - POST, Schreiben - PUT, PATCH, Löschen - DELETE |
- Wenn Sie auf Speichern, klicken, wird Ihnen das Secret angezeigt. Dies sollte entsprechend gespeichert und behandelt werden, da es sich um sehr sensible Informationen handelt. Sie können diese Informationen nicht erneut anzeigen.
- Speichern Sie das clientSecret sicher an einem Ort Ihrer Wahl und klicken Sie erst dann auf Fertig. Sie können Ihr clientSecret nicht erneut anzeigen. Sie können nur die clientId und UUID der Anmeldedaten anzeigen.
Anmeldedaten bearbeiten
Sie können nur den Namen und die Beschreibung der REST API-Anmeldedaten bearbeiten. Wenn Sie die Bereiche und/oder Berechtigungen bearbeiten müssen, müssen Sie neue erstellen und dann die alten löschen.
