1. Support
  2. Base de connaissances
  3. API d'Uptrends
  4. Authentification (version 4)

Authentification (version 4)

Nous changeons notre interface. Certaines informations peuvent ne pas être à jour. En savoir plus.

Chaque méthode API nécessite une authentification via un compte API, donc vous devrez donc d’abord en créer un. Ce compte API est basé sur votre compte Uptrends, mais ce n’est pas le même. L’avantage d’avoir des comptes séparés est que vous utilisez les identifiants de l’API dans des scripts par exemple sans avoir à divulguer vos identifiants de compte Uptrends.

La méthode POST de l’endpoint /Register vous permet de créer un nouveau compte API. Dans la description des étapes, nous utiliserons l’environnement Swagger pour accéder directement à l’API. Le compte API que nous allons créer n’expirera pas, vous n’aurez donc besoin de le faire qu’une seule fois.

Enregistrer un compte API

  1. Aller à la page Swagger, et localisez et développez la méthode POST /Register.

  2. Cliquez sur le bouton Try it out pour démarrer la création d’un compte API.

  3. Cliquez sur le bouton Execute.

  4. Votre navigateur vous demandera maintenant vos identifiants de connexion d’opérateur Uptrends. Renseignez l’adresse e-mail et le mot de passe que vous utilisez normalement pour accéder à Uptrends et cliquez sur OK.

  5. Une fois les informations de connexion de votre compte Uptrends vérifiées, vous recevrez une réponse dont le corps contient des valeurs pour UserName et Password.

    {
       "UserName": "usernamehere",
       "Password": "passwordhere",
       "AccountId": "123456",
       "OperatorName": "Your name",
       "status": "OK"
    }
    

    Ce sont les informations d’identification de votre nouveau compte API.

  6. Cliquez sur le bouton Download dans le corps de la réponse pour enregistrer ces informations d’identification, puis conservez-les en lieu sûr. Utilisez-les comme authentification pour tous les autres appels d’API.

Remarque : Le compte API n’expirera pas. Cependant, si vous perdez vos identifiants, ils ne peuvent pas être récupérés. Vous devrez créer un nouveau compte API.

Utilisation de votre compte API

Maintenant que vous avez un compte API, vous pouvez commencer à l’utiliser. Si vous utilisez Swagger, vous fournissez les informations d’identification dans une boîte de dialogue. Avec des logiciels comme cURL ou Postman, vous les fournissez comme en-têtes et l’encodage se fait automatiquement. Si vous utilisez vos propres scripts, vous devez d’abord encoder vos identifiants ; lisez la section ci-dessous Authentification de base.

Remarque : N’oubliez pas que ce compte API est lié à votre compte opérateur Uptrends, il aura donc les mêmes privilèges que ce dernier.

Environnement Swagger

Si vous exécutez des méthodes API dans l’environnement Swagger, une fenêtre popup Sign in (à api.uptrends.com) apparaîtra où il faudra entrer votre nom d’utilisateur et votre mot de passe de compte API.

Authentification de base

Les identifiants du compte doivent toujours être encodées à l’aide du schéma d’authentification de base et fournis à l’API en tant qu’en-tête particulier.

Des logiciels comme Postman, cURL, etc. se chargeront d’encoder ces identifiants et de les fournir correctement. Si vous écrivez votre propre script, vous devez fournir cet en-tête à l’appel API :

Authorization: Basic {{identifiants encodés}}

L’encodage doit être fait en base64. Pour créer l’en-tête, procédez comme suit :

  1. Définissez une chaîne avec la syntaxe username:password, en remplaçant username et password avec vos informations d’identification. N’ajoutez aucun espace.

  2. Cette chaine username:password doit être encodé en base64. La fonction d’encodage existe peut-être dans votre logiciel ou langage de script, sinon utilisez un outil tel que https://www.base64encode.org.

  3. Une fois la chaîne encodée, utilisez-la telle quelle dans un en-tête Autorisation: Basic {{VotreChaineEencodée}}.

En utilisant ce site, vous consentez à l’utilisation de cookies conformément à notre Politique de cookies.