Die meisten API-Aufrufe erfordern einen authentifizierten Benutzer. Die APIs verwenden keine speziellen Benutzerprofile. Jede API kann im Namen eines beliebigen bestehenden Benutzers unter Verwendung dessen Benutzernamens und Passworts aufgerufen werden.
Es gibt zwei Methoden zur Authentifizierung bei der API:
-
Tokenbasierte Authentifizierung
-
OAuth-2.0-Authentifizierung
Tokenbasierte Authentifizierung
Vor dem Aufruf einer API, die einen authentifizierten Benutzer voraussetzt, die auth/login-API aufrufen, um ein Authentifizierungs-Token zu erhalten. Das Token ist 24 Stunden lang gültig und kann für alle nachfolgenden Aufrufe verwendet werden, läuft jedoch ab, wenn sich der Benutzer über die Benutzeroberfläche abmeldet. Nicht für jeden Aufruf ein neues Token erstellen.
Mitglieder mehrerer TMS-Organisationen haben denselben Benutzernamen und dasselbe Passwort für mehrere Konten. Wenn mehrere Konten verwendet werden, muss der Parameter userUid zum Anfragetext hinzugefügt werden, um anzugeben, bei welcher Organisation sich der Benutzer anmelden möchte. Wenn dies nicht angegeben ist, wird der Benutzer bei dem Standardkonto angemeldet, das mit dem angegebenen Benutzernamen und Passwort verknüpft ist.
Bei nachfolgenden API-Aufrufen wird das erhaltene Token im Authorization-Header verwendet. Das Header-Wertfeld wird mit ApiToken eingeleitet, gefolgt von einem Leerzeichen und dem Token selbst.
Wenn sich ein Benutzer über die Benutzeroberfläche abmeldet, ist das API-Token nicht mehr gültig.
Wenn sich ein Profil im US-Rechenzentrum befindet, us. vor cloud.memsource.com einfügen, zum Beispiel https://us.cloud.memsource.com/web/api2/v3/auth/login.
Beispiel:
OAuth-2.0-Authentifizierung
In Anwendungen OAuth 2.0 verwenden, statt bei jedem Aufruf Token zu senden. Phrase TMS unterstützt den standardmäßigen OAuth 2.0-Autorisierungscode-Grant-Typ. Dieser OAuth 2.0-Flow ist ein Autorisierungscode-Grant für öffentliche Clients, der nur durch die Redirect-URI validiert wird, ohne Client Secret und ohne PKCE (code_challenge)-Unterstützung. Vor dem Fortfahren sicherstellen, dass ein Drittanbieter-Tool allein mit Client ID und Redirect-URI funktioniert.
Hinweis
OAuth-Login wird für Benutzerkonten, die zu mehr als einer Organisation gehören, nicht unterstützt.
Das Benutzerkonto entweder aus einer der Organisationen entfernen, sodass es nur noch einer Organisation angehört, oder stattdessen die tokenbasierte Authentifizierung verwenden.
Zum Herstellen der OAuth-2.0-Verbindung die folgenden Schritte ausführen:
-
Auf der Seite Settings
nach unten zum Bereich scrollen und auf Registered OAuth Apps klicken.
Die Seite wird geöffnet.
-
Klicke auf Neu.
Die Seite wird geöffnet.
-
Die Felder und (Callback) sowie optional ausfüllen.
-
Klicke auf Importieren.
Die Seite wird geöffnet, wobei die neue Verbindung in der Liste erscheint und eine zugehörige aufweist.
Die ID wird in der Anwendung verwendet, die eine Verbindung zu Phrase herstellt, um die Verbindung aufzubauen. Sie wird in der Datenbank gespeichert und dazu verwendet, Anfragen dem richtigen Anfragesteller zuzuordnen.
-
Zur Autorisierung diese URLs zusammen mit der generierten Client ID verwenden:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Wenn sich ein Profil im US-Rechenzentrum befindet, us. vor cloud.memsource.com einfügen, zum Beispiel https://us.cloud.memsource.com/web/oauth/authorize.
-
-
Bei der Autorisierung mit dem Administratorprofil anmelden und auf Allow klicken.
Die Anwendung ist nun verknüpft und der Authentifizierungs-API-Aufruf ist nicht mehr erforderlich.
Sobald die OAuth-2.0-Verbindung hergestellt ist, wird ein Bearer-Token für die Verwendung in der Anwendung generiert.
Beispiel für die Verwendung eines Bearer-Tokens:
Gültigkeit des Bearer-Tokens
Ein OAuth-2.0-Bearer-Token bleibt gültig, wenn sich der Benutzer, der die Anwendung autorisiert hat, bei Phrase abmeldet. Dies unterscheidet sich von einem API-Token, das über auth/login abgerufen wurde und abläuft, wenn sich der Benutzer abmeldet.
Ein Bearer-Token funktioniert nicht mehr, wenn:
-
Das Passwort des Benutzers, der die Anwendung autorisiert hat, geändert wird.
-
Die OAuth-App auf der Seite gelöscht wird.