La plupart des appels d'API nécessitent un utilisateur authentifié. Les API n'utilisent pas de profils d'utilisateur spéciaux. Chaque API peut être appelée au nom de tout 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 toute 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 suivants, 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 à quelle organisation l'utilisateur souhaite se connecter. Si non spécifié, l'utilisateur se connecte au compte par défaut associé au nom d'utilisateur et au mot de passe donnés.
Dans les appels API suivants, le jeton obtenu est utilisé dans l'en-tête Authorization. Le champ de valeur de l'en-tête est introduit 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 DataCenter des États-Unis, ajoutez us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/api2/v3/auth/login.
Exemple :
Authentification OAuth 2.0
Utilisez OAuth 2.0 dans les applications au lieu d'envoyer des jetons avec chaque appel. Phrase TMS prend en charge un type de code d'autorisation standard OAuth 2.0.
Pour établir la connexion OAuth 2.0, suivez ces étapes :
-
Depuis la page des paramètres
, faites défiler vers le bas jusqu'à la section et cliquez sur Applications OAuth enregistrées.
La page s'ouvre.
-
Cliquez sur Nouveau.
La page s'ouvre.
-
Fournissez un , un (Callback) et une optionnelle.
-
Cliquez sur Enregistrer.
La page s'ouvre avec la nouvelle connexion dans la liste et un 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 demandes au bon demandeur.
-
Utilisez ces URL avec l'ID client généré pour l'autorisation :
-
URL d'authentification
https://cloud.memsource.com/web/oauth/authorize
-
URL de jeton
https://cloud.memsource.com/web/oauth/token
Si un profil est situé dans le DataCenter américain, ajoutez us. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/oauth/authorize
-
-
Lors de l'autorisation, utilisez le profil Administrateur pour vous connecter et cliquez sur Autoriser.
L'application est maintenant liée et l'appel 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 :