Comptes API

INTRODUCTION

Les Comptes API 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 et une partie de vos données analytiques à un moment particulier.

Vous pouvez ici créer des comptes virtuels associés à des URLs de l'API de Reporting permettant aux personnes à qui vous communiquez ces URLs de visualiser les données correspondantes.

L’utilisation d’un code unique (GUID) nous permet d’embarquer l’authentification directement dans l’URL, ce qui vous évite de devoir créer un compte utilisateur AT Internet pour chacun des destinataires.

CRÉER UN COMPTE API

Depuis le menu de navigation de l'Analytics Suite 2, allez dans Configuration > Comptes API.

A partir de la page d’accueil :

  1. créez un nouveau compte API en cliquant sur le bouton Nouveau [a].
  2. Nommez votre compte [b],
  3. choisissez le site concerné [c],
  4. puis la période sur laquelle vous souhaitez donner accès aux données grâce aux dates de début et de fin [d].
  5. Puis validez [e].

Remarque : il ne s’agit pas des dates de l’appel API, mais bien de la durée de validité du compte API.

Astuce :
Il peut être judicieux de rappeler le nom du site choisi dans l’intitulé du compte API.

ASSOCIER UNE URL À UN COMPTE API

Une fois votre compte créé, vous allez pouvoir choisir la ou les URL que vous souhaitez associer à ce compte pour les partager :

  • Si besoin vous pouvez modifier ce compte [a]
  • Un GUID est désormais associé à votre compte API [b].
  • Pour commencer l’ajout d’URL, cliquez donc sur [c].
  • Vous pouvez au choix vous rentre dans l’application Data Query pour y créer une nouvelle URL API [d].
  • Sélectionner un des templates Standard proposé par AT Internet [e], ou copier une URL que vous avez déjà créée [f].
  • Cliquez sur Enregistrer.

PARTAGER UNE URL API

Une fois L’URL rattachée au compte API, il ne vous reste plus qu’à cliquer sur le logo en forme de chaine à droite [a].
Une pop-up s’ouvrira alors, vous affichant l’URL à communiquer en externe [b].
La clé d’authentification est automatiquement embarquée dans l’URL.
Ainsi, la personne a qui vous avez partagé l’URL n’a plus qu’à l’appeler dans son navigateur web pour y afficher le jeu de résultat.
Si besoin, vous pouvez modifier l’URL saisie en cliquant sur le stylet, ou la supprimer.

Astuce :
Par défaut le format de sortie est le JSON. Si besoin, il est possible de le changer en HTML ou XML directement dans l’URL à la place de JSON.

PARAMÈTRES MODIFIABLES

Voici la liste des seuls paramètres pouvant être modifiés dans l’URL (et donc par le client) :

  • MaxResult > déjà présent dans l’URL : &max-results=
    Ce paramètre correspond au nombre de ligne total à afficher. Par défaut celui-ci est fixé à 20, mais il peut être modifié, jusqu’à 10 000.
  • Période de l’appel > déjà présent dans l’URL : &period= Par défaut la période est J-1.
  • Séparateur de décimales (point ou virgule) > ajouter &sep=comma ou &sep=dot
  • Langue > ajouter &lng= Par défaut ce paramètre n’est pas affiché, et la langue celle du site à laquelle le compte API est rattaché. Pour changer la langue, rajoutez &lng= avec l’indicateur de la langue souhaitée à n’importe quel endroit dans l’URL API :
    • fr pour Français,
    • en pour Anglais,
    • es pour Espagnol
    • de pour Allemand,
    • pt pour Portugais
    • ru pour Russe.

RÈGLES FONCTIONNELLES

Il existe 6 règles fonctionnelles :

  1. Validité du compte API : la date de fin doit être postérieure à la date de début.
  2. Les Comptes API ne fonctionnent que sur les sites de Niveau 1.
  3. Il est impossible d’associer à un compte API une URL reposant sur un site différent de celui choisi lors de la création du compte.
  4. Une fois qu’une URL a été associée à un compte API, il est impossible de modifier le site de référence du compte.
  5. Seules les URLs générées depuis Data Query (API de Reporting) sont autorisées. Les URLs Data Flow et l'API de Campagnes ne fonctionnent pas.
  6. Si le compte de l’utilisateur à l’origine des comptes API est supprimé, alors les comptes API ne fonctionneront plus.
Vous avez d’autres questions ? Envoyer une demande