API Authentication (TMS)

Inhalte werden von Phrase Language AI maschinell aus dem Englischen übersetzt.

Die meisten API-Aufrufe erfordern einen authentifizierten User. Die APIs verwenden keine speziellen Profile. Jede API kann im Namen eines bestehenden Users mit dessen Benutzernamen und Passwort aufgerufen werden.

Es gibt zwei Methoden zur Authentifizierung mit der API:

Token-basierte Authentifizierung
OAuth 2.0 Authentifizierung

Token-basierte Authentifizierung

Vor dem Aufruf einer API, die einen authentifizierten User erfordert, sollte die auth/login API aufgerufen werden, um ein Authentifizierungs-Token zu erhalten. Das Token ist 24 Stunden gültig und kann für alle nachfolgenden Aufrufe verwendet werden, läuft aber ab, wenn sich der User über die UI abmeldet. Nicht für jeden Aufruf ein neues Token erstellen.

Mitglieder mehrerer TMS-Organisationen haben denselben Benutzernamen und dasselbe Passwort für mehrere User-Konten. Wenn mehrere User-Konten verwendet werden, muss userUid dem Request-Body hinzugefügt werden, um anzugeben, bei welcher Organisation sich der User anmelden möchte. Wenn nicht angegeben, wird der User beim Standard-User-Konto 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 gefolgt von einem Leerzeichen und dem Token selbst eingeführt.

Wenn sich ein User von der UI abmeldet, ist das API-Token nicht mehr gültig.

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/api2/v3/auth/login.

Beispiel:

ApiToken OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi

OAuth 2.0 Authentifizierung

OAuth 2.0 in Anwendungen verwenden, anstatt Token mit jedem Aufruf zu senden. Phrase TMS unterstützt einen Standard-OAuth 2.0 Autorisierungscode-Grant-Typ.

Um die OAuth 2.0-Verbindung herzustellen, sind die folgenden Schritte zu befolgen:

Auf der Einstellungsseite scrollt man zum Abschnitt Integrationen und klickt auf Registrierte OAuth-Apps.

Die Registrierte OAuth-Apps Seite öffnet sich.
Auf New ist zu klicken.

Die Seite OAuth-App erstellen wird angezeigt.
Es ist ein Name, Umleitungs-URI (Callback) und, falls gewünscht, eine Beschreibung anzugeben.
Auf Speichern klicken.

Die Seite Registrierte OAuth-Apps öffnet sich mit der neuen Verbindung in der Liste und einer zugehörigen Client ID.

Die ID wird in der Anwendung verwendet, die sich mit Phrase verbindet, um die Verbindung herzustellen. Die ID wird in der Datenbank gespeichert und verwendet, um Anfragen mit dem richtigen Anforderer zu verknüpfen.
Diese URLs sind zusammen mit der generierten Client ID für die Autorisierung zu verwenden:
- Auth-URL
  
  https://cloud.memsource.com/web/oauth/authorize
- Token-URL
  
  https://cloud.memsource.com/web/oauth/token
Befindet sich ein Profil im US DataCenter, fügen Sie us. vor cloud.memsource.com hinzu, zum Beispiel https://us.cloud.memsource.com/web/oauth/authorize
Beim Autorisieren ist die Administratorrolle für die Anmeldung zu verwenden und es ist auf Allow zu klicken.

Die Anwendung ist jetzt verknüpft und der Authentifizierungs-API-Aufruf ist nicht erforderlich.

Sobald die OAuth 2.0-Verbindung hergestellt ist, wird ein Bearer-Token zur Verwendung in der Anwendung generiert.

Beispiel für die Verwendung des Bearer-Tokens:

Bearer OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi