Les API keys pour les connexions externes

Qu'est-ce-qu'une API key

Une API key est une chaine de caractères qui peut être générée par un utilisateur après son authentification sur l'Analytics Suite 2. Une API key vise à être utilisée en requêttant l'API REST AT Internet au lieu de renseigner les identifiants de l'authentification basique.

 

Qui peut créer une API key

Une API key peut seulement être créée par un utilisateur authentifié qui peut manipuler les données. Cet utilisateur doit avoir au moins l'un des rôles suivants:

  • Administrateur
  • Délégué
  • Analyste avancé
  • Analyste
  • Rôle personnalisé avec l'outil "Manipuler les données"

L'API key est créée, activée, supprimée par chaque utilisateur de façon indépendante.

 

Utiliser une API key

Une API Key donne les mêmes permissions que celles de l'utilisateur qui l'a créé. Si l'utilisateur perds les droits sur un site, alors il ne sera plus en mesure d'utiliser son API key pour obtenir des données de ce site. Si l'utilisateur obtiens de nouveaux droits sur un nouveau site, alors il sera en mesure d'utiliser son API key pour obtenir des données de ce site.

L'API key vise à être utilisée avec les URLs REST récupérées de Data Query. Nous vous invitons à utiliser une API key au lieu de renseigner vos identifiants de connexion utilisant la connexion basique lors du requêtage de l'API avec un outil tiers (script ou autre).
Si vous êtes un utilisateur SSO, vous devez utiliser une API key pour requêter l'API REST AT Internet.

 

Comment créer une API key

1. Cliquez sur « Voir profil »
apik1.png

2. Ouvrez l'onglet « API KEYS » 
3. Cliquez sur le bouton « Créer une nouvelle API key »

apik2.png

4. Renseignez un nom et une description
5. Cliquez sur le bouton « Créer une nouvelle API key »

apik3.png

6. Copiez l'API key en cliquant sur le bouton Copier et enregistrez la en lieu sûr
7. Confirmez l'action en cochant la case de confirmation

apik4.png

Veuillez noter que pour des raisons de sécurité l'API key complète ne sera affichée uniquement qu'au cours de ce processus décrit plus tôt.

Un utilisateur peut générer une API key pour chaque projet/utilisation de l'API REST AT Internet. Pour identifier facilement l'API key sur l'interface, nous recommandons l'utilisation de noms clairs et d'une description pour chaque API key.

 

Comment afficher les API keys existantes

Les API keys sont affichées dans un tableau fournissant à l'utilisateur les informations suivantes :
1. Nom de l'API key
2. Description de l'API key
3. Premiers caractères de l'API key
4. Date de création 
5. Date de dernière utilisation
6. Statut de l'API key : Active/Inactive

apik5.png


Comment modifier une API key

Depuis le tableau affichant les API keys, l'utilisateur peut éditer chacune d'entre elles pour :
1. Mettre à jour les noms ou description
2. Rendre l'API key inactive

Dès que l'API key est inactive, elle peut-être supprimée par son propriétaire.

Veuillez noter que la suppression d'une API key est une action définitive. Une API key supprimée ne peut être restaurée.

 

Comment utiliser une API key

Une API key peut être transmise dans le header de requête : le paramètre est x-api-key.

 

Exemple header de requête :

https://api.atinternet.io/data/v2/json/getData?columns=%7Bm_visits%7D&sort=%7B-m_visits%7D&space=%7Bs:123456%7D&period=%7BD:%7Bstart:%272018-08-26%27,end:%272018-08-26%27%7D%7D&max-results=20&page-num=1
• x-api-key: e8005ef09a17_039a21e785851e51111111111130cf3157*****

apik7.png

Requête transmise en utilisant Postman

 

Sécurisez vos API keys

Si vous avez recours à des API keys, nous vous invitons à vous assurer de :

  • Les conserver dans un lieu sûr.
  • Si vous devez partager une API key avec quelqu'un, créer une nouvelle API key avec un nom spécifique et une description dédiée, pour la désactiver ou la supprimer dès que vous le pouvez.
  • Supprimer les API keys inutiles régulièrement.
  • Renouveler les API keys utilisées par vos programmes régulièrement.
Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 3 sur 4
Vous avez d’autres questions ? Envoyer une demande