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.

 

Veuillez noter que 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 :

(1) L’URL de l’appel API que vous souhaitez effectuer.
(2) Le format de sortie des données renvoyées par l’API : JSON ou XML.
(3) Le mode de connexion à l’API : aucune authentification, authentification basique (login/mot de passe), OAuth.
Les éléments optionnels sont les suivants :
(5) Headers.

07-external-data-2.png

 

> 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 :

HELP_DB_URL.png

Renseignez le champ « Start date », avec le paramètre « start-date », et le champ « End date » avec le paramètre « end-date ». 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 affichées les données renvoyées par l’API.

 

Vous avez d’autres questions ? Envoyer une demande