Comptes API

Définition

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.

Droits pour créer un Compte API

Un compte API peut uniquement être créé 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é
• Advanced Analyst
• Analyst
• Custom Role avec le rôle “Manipuler les données”
• Data Supervisor

Le Compte API est créé, activé, désactivé, et supprimé par chaque utilisateur indépendamment.

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.
2. Nommez votre compte [a],
3. choisissez le site concerné [b],
4. puis la période sur laquelle vous souhaitez donner accès aux données grâce aux dates de début [c] et de fin [d].
5. Puis validez [e].

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 rendre dans l’application Data Query pour y créer une nouvelle URL API [d].
• Sélectionnez un des templates Standard proposé par Piano Analytics [e], ou copiez une URL que vous avez déjà créée [f].
• Cliquez sur Enregistrer[g].

Partager une URL de Compte 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