Flux de données éligibles
Les données doivent être fournies par une API REST, aux formats XML ou JSON.
Les modes d’authentification possibles sont les suivants :
- Authentification basique (via formulaire ou headers),
- Jetons OAuth.
Les APIs ne requérant aucune authentification peuvent également être appelées.
Dans le cas d’APIs nécessitant une connexion OAuth, nous proposons actuellement les connecteurs suivants :
- Facebook (API graph)
- Twitter (API publique)
- YouTube analytics
- OnCrawl
- Google Analytics
Cette liste s’enrichit régulièrement. Pour être informé des nouvelles possibilités de connexions, consultez les nouveautés sur votre interface.
Ajouter un flux de données externes
Afin de procéder à l’affichage de données externes, vous devez sélectionner l’option "Données externes" lors de la création d’un nouveau jeu de données.
Se connecter à une API (étape 1)
Mode d’authentification à l’API
Les APIs auxquelles vous allez vous connecter nécessitent dans certains cas une authentification de votre part. Consultez la documentation utilisateur de l’API que vous souhaitez utiliser pour connaître son mode d’authentification, et créer un éventuel compte ou une clé utilisateur.
APIs publiques
Un certain nombre d’APIs ne nécessite pas d’authentification (c’est par exemple le cas des APIs proposant des données Open Data), ou permettent une authentification directement dans l’URL de l’appel. Dans ce cas, veillez à cocher l’option « Aucune » dans la zone « Authentification ».
APIs avec authentification « http basique »
Sélectionnez l’option « Login / Mot de passe » puis saisissez vos identifiants.
APIs avec authentification OAuth
Cochez l’option « OAuth » : une liste déroulante s’affiche alors, proposant l’ensemble des connexions OAuth que vous avez déjà activées. Sélectionnez celle qui doit être utilisée dans le cas de l’appel API que vous souhaitez effectuer.
Note
Pour utiliser cette option vous devez avoir préalablement activé le connecteur OAuth adéquat en vous rendant sur votre profil utilisateur.Champs obligatoires
La connexion à une API tierce requiert les éléments suivants :
- L’URL de l’appel API que vous souhaitez effectuer.
- Le format de sortie des données renvoyées par l’API : JSON ou XML.
- Le mode de connexion à l’API : aucune authentification, authentification basique (login/mot de passe), OAuth.
Champs facultatifs : paramètres de dates
Il est possible de rafraîchir « dynamiquement » les données externes en fonction de la période d’analyse sélectionnée dans le tableau de bord. L’API que vous utilisez doit le permettre, en autorisant des paramètres de date de début et de fin dans l’URL qui permet de générer l’appel.
Pour activer cette fonctionnalité, il vous suffit simplement de reporter les noms des variables correspondant aux dates de début et de fin de l’URL dans les champs dédiés, puis de spécifier le format de la date passée dans l’URL (4).
Généralement le format proposé par les APIs est de la forme yyyy-MM-dd. Nous proposons néanmoins d’autres formats, ainsi que la possibilité de renseigner un format personnalisé.
Exemple :
https://youtubeanalytics.googleapis.com/v2/reports?dimensions=ageGroup%2Cgender&startDate=2019-01-01&endDate=2019-07-01&ids=channel%3D%3DMINE&metrics=viewerPercentage&sort=gender%2CageGroup
Renseignez le champ « Start date », avec le paramètre « startDate », et le champ « End date » avec le paramètre « endDate ». Conserver le format de date yyyy-MM-dd.
Si vous ne saisissez pas ces informations, votre tableau de bord affichera les données des dates saisies directement dans l’URL de l’appel API.
Astuce
Si vous ne connaissez pas les éléments à renseigner dans cette fenêtre de configuration, veuillez-vous référer à la documentation de l’API à laquelle vous souhaitez vous connecter.Cliquez sur le bouton « Suivant » pour effectuer l’appel et afficher les données renvoyées par l’API.
Configuration et association (étape 2)
Nommez votre jeu de données (non obligatoire, si vous ne saisissez rien, un nom automatique sera attribué) (1). Sélectionnez ensuite les éléments à utiliser en tant que dimensions ou métriques dans votre jeu de données, en les survolant puis en spécifiant pour chacun s’il s’agit d’une dimension ou d’une métrique (2). Vous pouvez également spécifier si un élément doit être utilisé en tant que « granularité » pour créer une notion d’évolution dans un graphique (une date par exemple).
L’ensemble des éléments que vous avez sélectionnés apparait sur la droite de la fenêtre. Renommez-les si vous le souhaitez pour une restitution plus explicite dans votre tableau de bord. Vous pouvez également réorganiser l’ordre des éléments de votre jeu de données par un simple jeu de glisser-déposer. (3)
Finalisez la création du jeu de données en cliquant sur le bouton « OK ».
Voici un exemple de rendu final :
Documentation développeurs
Pour obtenir la liste des informations rendues disponibles par chacune des APIs que vous souhaitez utiliser, vous devez vous référer à leur documentation développeurs.
En voici quelques exemples :