Die meisten API-Aufrufe erfordern einen authentifizierten User. Die APIs verwenden keine speziellen User-Profile. Jede API kann im Namen eines beliebigen existierenden Users unter Verwendung seines Usernamens und Passworts aufgerufen werden.
Es gibt zwei Methoden zur Authentifizierung mit der API:
-
Token-basierte Authentifizierung
-
OAuth 2.0-Authentifizierung
Token-basierte Authentifizierung
Bevor Sie eine API aufrufen, die einen authentifizierten User erfordert, rufen Sie die auth/login API auf, 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 der User sich über die UI abmeldet. Erstellen Sie nicht für jeden Aufruf ein neues Token.
Mitglieder mehrerer TMS-Organisationen haben denselben Usernamen und dasselbe Passwort für mehrere User-Konten. Wenn mehrere User-Konten verwendet werden, muss die userUid zum Request-Body hinzugefügt werden, um anzugeben, bei welcher Organisation der User sich anmelden möchte. Wenn dies nicht angegeben ist, wird der User bei dem Standard-User-Konto angemeldet, das mit dem angegebenen Usernamen 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 ein User sich von der UI abmeldet, ist das API-Token nicht mehr gültig.
Wenn sich ein Profil im US-Rechenzentrum befindet, fügen Sie us. vor cloud.memsource.com hinzu, zum Beispiel https://us.cloud.memsource.com/web/api2/v3/auth/login.
Beispiel:
OAuth 2.0-Authentifizierung
Verwenden Sie OAuth 2.0 in Anwendungen, anstatt bei jedem Aufruf Token zu senden. Phrase TMS unterstützt einen standardmäßigen OAuth 2.0 authorization code grant type. Dieser OAuth 2.0-Ablauf ist ein Public-Client-Autorisierungscode-Grant, der nur per Redirect URI validiert wird, ohne Client Secret und ohne PKCE (code_challenge)-Unterstützung. Bestätigen Sie, dass ein Drittanbieter-Tool mit Client ID und Redirect URI allein funktionieren kann, bevor Sie fortfahren.
Hinweis
OAuth-Login wird für User-Konten, die zu mehr als einer Organisation gehören, nicht unterstützt.
Entfernen Sie entweder das User-Konto aus einer der Organisationen, sodass es nur zu einer Organisation gehört, oder verwenden Sie stattdessen eine Token-basierte Authentifizierung.
Um die OAuth 2.0-Verbindung herzustellen, folgen Sie diesen Schritten:
-
Scrollen Sie auf der Seite Einstellungen
nach unten zum Bereich und klicken Sie auf Registered OAuth Apps.
Die Seite wird geöffnet.
-
Klicke auf Neu.
Die Seite wird geöffnet.
-
Geben Sie einen , eine (Callback) und eine optionale an.
-
Klicke auf Importieren.
Die Seite wird geöffnet, mit der neuen Verbindung in der Liste und einer zugehörigen .
Die ID wird in der Anwendung verwendet, die eine Verbindung zu Phrase herstellt, um die Verbindung aufzubauen. Sie wird in der Datenbank gespeichert und verwendet, um Anfragen mit dem richtigen Anfragesteller zu verknüpfen.
-
Verwenden Sie diese URLs mit der generierten Client ID zur Autorisierung:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Wenn sich ein Profil im US DataCenter befindet, fügen Sie us. vor cloud.memsource.com hinzu, zum Beispiel https://us.cloud.memsource.com/web/oauth/authorize.
-
-
Verwenden Sie bei der Autorisierung die Administratorrolle, um sich anzumelden, und klicken Sie auf Allow.
Die Anwendung ist nun verknüpft und der API-Aufruf zur Authentifizierung ist nicht erforderlich.
Sobald die OAuth 2.0-Verbindung hergestellt ist, wird ein Bearer-Token zur Verwendung in der Anwendung generiert.
Beispielhafte Verwendung des Bearer-Tokens: