API de Phrase TMS

Authentification à l’API (TMS)

Le contenu est traduit de l’anglais par Phrase Language AI.

La plupart des appels API nécessitent un utilisateur authentifié. Les API n'utilisent aucun profil utilisateur spécial. Chaque API peut être appelée au nom de n'importe quel utilisateur existant en utilisant son nom d'utilisateur et son mot de passe.

Il existe deux méthodes pour s'authentifier auprès de l'API :

  • Authentification par jeton

  • Authentification OAuth 2.0

Authentification par jeton

Avant d'appeler une API nécessitant un utilisateur authentifié, appelez l'API auth/login pour obtenir un jeton d'authentification. Le jeton est valide pendant 24 heures et peut être utilisé pour tous les appels ultérieurs, mais il expirera si l'utilisateur se déconnecte via l'interface utilisateur. Ne créez pas un nouveau jeton pour chaque appel.

Les membres de plusieurs organisations TMS ont le même nom d'utilisateur et le même mot de passe pour plusieurs comptes. Si plusieurs comptes sont utilisés, le userUid doit être ajouté au corps de la requête pour spécifier l'organisation à laquelle l'utilisateur souhaite se connecter. S'il n'est pas spécifié, l'utilisateur est connecté au compte par défaut associé au nom d'utilisateur et au mot de passe fournis.

Dans les appels API ultérieurs, le jeton obtenu est utilisé dans l'en-tête Authorization. La valeur de l’en-tête commence par ApiToken, suivi d’un espace et du jeton lui-même.

Si un utilisateur se déconnecte de l'interface utilisateur, le jeton API ne sera plus valide.

Si un profil est situé dans le centre de données américain, ajoutez us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/api2/v3/auth/login.

Exemple : 

ApiToken OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi 

Authentification OAuth 2.0

Utilisez OAuth 2.0 dans les applications au lieu d'envoyer des jetons à chaque appel. Phrase TMS prend en charge le flux d’autorisation par code standard d’OAuth 2.0. Ce flux OAuth 2.0 repose sur l’octroi d’un code d’autorisation à un client public, validé uniquement par l’URI de redirection, sans secret client ni prise en charge de PKCE (code_challenge). Confirmez qu'un outil tiers peut fonctionner avec le Client ID et l'URI de redirection seuls avant de continuer.

Remarque

La connexion OAuth n'est pas prise en charge pour les comptes utilisateur appartenant à plus d'une organisation.

Supprimez le compte utilisateur de l'une des organisations afin qu'il n'appartienne qu'à une seule organisation, ou utilisez plutôt l'authentification par jeton.

Pour établir la connexion OAuth 2.0, suivez ces étapes :

  1. Depuis la page Paramètres Setup_gear.png, faites défiler jusqu'à la section Integrations et cliquez sur Registered OAuth Apps.

    La page Registered OAuth Apps s'ouvre.

  2. Cliquez sur Nouveau.

    La page Create OAuth App s'ouvre.

  3. Renseignez les champs Name et Redirect URI (URL de rappel), ainsi que le champ facultatif Description.

  4. Cliquez sur Enregistrer.

    La page Registered OAuth Apps s'ouvre avec la nouvelle connexion dans la liste et un Client ID associé.

    L'ID est utilisé dans l'application qui se connecte à Phrase pour établir la connexion. Il est stocké dans la base de données et est utilisé pour associer les requêtes au demandeur approprié.

  5. Utilisez ces URL avec le Client ID généré pour l’autorisation :

    • Auth URL 

      https://cloud.memsource.com/web/oauth/authorize 

    • Token URL 

      https://cloud.memsource.com/web/oauth/token 

    Si un profil est situé dans le centre de données américain, ajoutez us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/oauth/authorize.

  6. Lors de l’autorisation, connectez-vous avec le profil Administrateur, puis cliquez sur Allow.

    L'application est désormais liée et l'appel d'API d'authentification ne sera pas requis.

Une fois la connexion OAuth 2.0 établie, un jeton Bearer est généré pour être utilisé dans l'application.

Exemple d'utilisation du jeton Bearer :

Bearer OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi 

Validité du jeton Bearer

Un jeton Bearer OAuth 2.0 reste valide lorsque l'utilisateur qui a autorisé l'application se déconnecte de Phrase. Ceci diffère d'un jeton d'API obtenu via auth/login, qui expire lorsque l'utilisateur se déconnecte.

Un jeton Bearer cesse de fonctionner lorsque :

  • Le mot de passe de l'utilisateur ayant autorisé l'application est modifié.

  • L’application OAuth est supprimée sur la page Registered OAuth Apps.

Cet article vous a-t-il été utile ?
★ ★ ★ ★ ★

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.