API Authentication (TMS)

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

Die meisten API-Aufrufe erfordern einen authentifizierten Benutzer. Die APIs verwenden keine speziellen Benutzerprofile. Jede API kann im Namen eines bestehenden Benutzers unter Verwendung seines Benutzernamens 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 Benutzer erfordert, rufen Sie die auth/login API auf, um ein Authentifizierungstoken zu erhalten. Das Token ist 24 Stunden gültig und kann für alle nachfolgenden Aufrufe verwendet werden, aber es läuft ab, wenn der Benutzer sich über die Benutzeroberfläche abmeldet. Erstellen Sie nicht für jeden Aufruf ein neues Token.

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

Wenn sich ein Benutzer von der Benutzeroberfläche abmeldet, ist das API-Token nicht mehr gültig.

Wenn ein Profil im US-Datenzentrum gespeichert ist, 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

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

Um die OAuth 2.0-Verbindung herzustellen, befolgen Sie diese Schritte:

Gehen Sie von der Einstellungen Seite zum Integrationen Abschnitt und klicken Sie auf Registrierte OAuth-Apps.

Die Registrierte OAuth-Apps Seite öffnet sich.
Klicke auf Neu.

Die OAuth-App erstellen Seite öffnet sich.
Geben Sie einen Namen, Umleitungs-URI (Callback) und eine optionale Beschreibung an.
Klicke auf Speichern.

Die Registrierte OAuth-Apps Seite ö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. Sie wird in der Datenbank gespeichert und verwendet, um Anfragen mit dem richtigen Anforderer 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-Datenzentrum befindet, fügen Sie us. vor cloud.memsource.com hinzu, zum Beispiel https://us.cloud.memsource.com/web/oauth/authorize
Beim Autorisieren verwenden Sie das Administratorprofil, um sich anzumelden, und klicken Sie auf Erlauben.

Die Anwendung ist jetzt verknüpft und der Authentifizierungs-API-Aufruf wird nicht mehr benötigt.

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