Définition
Les clés API restreintes ont pour objectif de vous permettre de diffuser et partager la donnée au sein de votre organisation, de manière sécurisée et contrôlable. Consultants externe, agences de conseil, partenaires, stagiaires, sont autant de personnes ayant un besoin d’accéder à une partie de vos données analytiques à un moment particulier sans pour autant avoir accès à l'intégralité de ces dernières. Les clés API restreintes vous permettent de créer une clé qui donnera accès à un seul jeu de donnée et qui se verra refuser l'accès à tout le reste, vous pouvez aussi choisir une plage de date sur laquelle elle sera active, par exemple la durée d'une prestation avec un partenaire.
La fonctionnalité est activable en effectuant une demande au centre support.
Créer une API Key restreinte
La première étape va être de configurer le jeu de donnée pour qu'il réponde à votre besoin. Si vous ne savez pas comment utiliser Data Query, vous pouvez retrouver toutes les informations dans cet article.
Une fois votre jeu de donnée créé avec vos propriétés, métriques ainsi que les potentiels filtres ou segments, vous devez cliquer sur le bouton Générer une clé API restreinte comme vous pouvez le voir.
Une fenêtre va s'ouvrir, vous permettant de configurer quelques informations :
-
La période sur laquelle l'API Key restreinte sera valide, en dehors de cette période elle ne fonctionnera plus.
-
Le Endpoint puis le Body qui sont nécessaires pour réaliser l'appel API, mais nous y reviendrons dans la partie dédiée.
Une clé API restreinte ne peut pas être modifiée. Si vous désirez changer les propriétés, métriques ou la période de validité, il est nécessaire de recréer une clé API restreinte. De même, une fois expirée, il sera nécessaire de la recréer et une API Key différente sera générée.
Une fois la configuration effectuée, vous pouvez cliquer sur le bouton Générer clé API.
À ce stade, votre clé d'API est générée. Il est très important de la copier et de la stocker de votre côté. En effet, pour des raisons de sécurité, nous ne pouvons pas restaurer la clé complète après sa création.
L'utilisation de l'API vis des API Key restreinte est très proche de l'utilisation de notre API, nous vous recommandons de retrouver comment l'utiliser dans cette documentation.
Cependant, il est tout de même nécessaire de rajouter quelques informations sur le body :
-
Il ne doit pas contenir les colonnes et lignes de l'appel. Cette information est directement contenue dans l'API Key restreinte.
-
Vous pouvez modifier la date comme vous le voulez, toutes les informations sur ce paramètre sont disponibles dans cet article.
-
Vous pouvez ajuster les paramètres page-num et max-results, disponible dans cet article.
-
Les filtres et segments sont intégrés directement dans la clé restreinte — ils ne sont pas visibles par les destinataires.
-
Le site_id ne peut pas être modifié dans le corps de la requête pour les clés restreintes.
La date ne peut être remplacée qu'avec le type de date qui était présent lors de la génération de la clé d'API restreinte. Si, par exemple, seul p1 était présent, alors ajouter p2 en plus retournera une erreur.
Exemple d'un appel API basique incluant une journée :
https://api.atinternet.io/v3/data/getData?param={"period":{"p1":[{"type":"D","start":"2025-01-15","end":"2025-01-15"}]}}
Lorsque vous utilisez cet appel dans un logiciel client API, l'authentification doit être gérée dans le header x-api-key avec la valeur accesskey_secretkey.
FAQs
Comment faire pour supprimer une API Key restreinte ?
Pour le moment, il est nécessaire de contacter le centre support avec l'API Key que vous voulez supprimer et nous procéderons à sa désactivation.