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 avec 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 pas créer 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 à quelle organisation l'utilisateur souhaite se connecter. Si rien n'est 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. Le champ de valeur de l'en-tête est introduit avec 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, ajouter us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/api2/v3/auth/login.
Exemple :
Authentification OAuth 2.0
Utiliser OAuth 2.0 dans les applications au lieu d'envoyer des jetons à chaque appel. Phrase TMS prend en charge un type d'octroi de code d'autorisation OAuth 2.0 standard.
Remarque
La connexion OAuth n'est pas prise en charge pour les comptes utilisateur appartenant à plus d'une organisation.
Retirer le compte utilisateur de l'une des organisations afin qu'il n'appartienne qu'à une seule organisation, ou utiliser une authentification par jeton à la place.
Pour établir la connexion OAuth 2.0, suivre ces étapes :
-
Depuis la page Paramètres
, faire défiler vers le bas jusqu'à la section et cliquer sur Registered OAuth Apps.
La page s'ouvre.
-
Cliquez sur Nouveau.
La page s'ouvre.
-
Fournir un , un (Callback) et une facultative.
-
Cliquez sur Enregistrer.
La page s'ouvre avec la nouvelle connexion dans la liste et un associé.
L'Identifiant 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é.
-
Utiliser ces URL avec l'Identifiant client généré pour l'autorisation :
-
URL d'authentification
https://cloud.memsource.com/web/oauth/authorize
-
URL du jeton
https://cloud.memsource.com/web/oauth/token
Si un profil est situé dans le centre de données américain, ajouter us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/oauth/authorize
-
-
Lors de l'autorisation, utiliser le profil administrateur pour se connecter et cliquer sur Autoriser.
L'application est maintenant 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 une utilisation dans l'application.
Exemple d'utilisation du jeton Bearer :