La plupart des appels API nécessitent un utilisateur authentifié. Les API n'utilisent aucun profil utilisateur particulier. 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 auprès de l'API :
-
Authentification basée sur un jeton
-
Authentification OAuth 2.0
Authentification basée sur les jetons
Avant d'appeler une API nécessitant un utilisateur authentifié, appelez l'API auth/login pour obtenir un jeton d'authentification. Le jeton est valable 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 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, l'identifiant utilisateur doit être ajouté au corps de la demande pour spécifier à quelle organisation 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 donnés.
Dans les appels API suivants, le jeton obtenu est utilisé dans l'en-tête Autorisation . Le champ de valeur d'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, ajoutez-nous. 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 à chaque appel. Phrase TMS prend en charge un type de code d’autorisation OAuth 2.0 standard.
Pour établir la connexion OAuth 2.0, procédez comme suit :
-
Dans la page
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.
-
Fournir un , (Rappel) 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 demandes avec le demandeur approprié.
-
Utiliser ces URL avec l'Identifiant client généré pour obtenir l'autorisation :
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
URL jeton
https://cloud.memsource.com/web/oauth/token
Si un profil est situé dans le centre de données américain, ajoutez-nous. avant cloud.memsource.com, par exemple https://us.cloud.memsource.com/web/oauth/authorize
-
-
En cas d'autorisation, utilisez le profil Administrateur pour vous connecter et cliquez sur Autoriser.
L'application est désormais reliée et l'appel API authentification ne sera pas nécessaire.
Une fois la connexion OAuth 2.0 établie, un jeton porteur est généré pour être utilisé dans l’application.
Exemple d’utilisation du jeton Bearer :