Authentification (version 4)

Chaque méthode API nécessite une authentification via un compte API, que vous devez d’abord créer. Ce compte API est basé sur votre compte Uptrends, mais ce n’est pas le même compte. Séparer ces deux comptes vous permet d’utiliser les identifiants de l’API dans des scripts (par exemple) sans avoir à divulguer vos identifiants de compte Uptrends.

Gérer les comptes API dans les paramètres des opérateurs

Les comptes API sont gérés directement dans les paramètres de l’opérateur auquel les comptes sont liés. Pour savoir comment ajouter ou supprimer des comptes API, consultez l’article sur la gestion des comptes API des opérateurs. Dans la plupart des cas, cette méthode est la plus simple pour enregistrer un compte API et connaître les comptes associés à chaque opérateur (en effet, plusieurs comptes peuvent être enregistrés pour un même opérateur).

Enregistrer un compte API en utilisant les appels d’API

Le compte API peut aussi être créé à l’aide de l’API d’Uptrends. Cette méthode est moins pratique et plus ancienne. Vous pouvez toutefois toujours l’utiliser, et le compte créé apparaîtra aussi dans l’onglet Gestion des API de l’opérateur.

La méthode POST de l’endpoint /Register vous permet aussi 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 suivre cette procédure qu’une seule fois.

Ouvrez la page Swagger et cliquez sur la méthode POST /Register.
Cliquez sur le bouton Try it out pour démarrer la création d’un compte API.
Cliquez ensuite sur le bouton Execute.
Votre navigateur vous demande maintenant les identifiants de connexion Uptrends de l’opérateur. Renseignez l’adresse e-mail et le mot de passe que vous utilisez normalement pour accéder à Uptrends et cliquez sur OK.
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": "nomdutilisateur",
  "Password": "motdepasse",
  "AccountId": "123456",
  "OperatorName": "Votre nom",
  "status": "OK"
}

Il s’agit des informations d’identification de votre nouveau compte API.

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, vous ne pouvez pas les récupérer. Vous devez alors recréer un compte API.

Utiliser 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 : Souvenez-vous que ce compte API est lié à votre compte d’opérateur sur Uptrends, et qu’il possède 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 contextuelle Sign in (à api.uptrends.com) apparaît et vous devez entrer votre nom d’utilisateur et votre mot de passe de compte API.

Authentification de base

Les identifiants du compte doivent toujours être encodés à 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 chargent 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 {{encoded credentials}}

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

Définissez une chaîne avec la syntaxe username:password, en remplaçant username et password par vos informations d’identification. N’ajoutez aucune espace.
La chaîne username:password doit être encodée en base64. La fonction d’encodage existe peut-être dans votre logiciel ou langage de script. Autrement, vous pouvez utiliser un outil tel que https://www.base64encode.org.
Une fois la chaîne encodée, créez et utilisez un en-tête Authorization: Basic {{encoded credentials}}, où la valeur encoded credentials correspond à la chaîne encodée en base64 issue de l’étape précédente.