Premiers pas avec l'API Looker

L'API Looker est une interface de programmation d'application sécurisée et RESTful qui permet de gérer votre instance Looker et d'extraire des données via la plate-forme de données Looker. Avec l'API Looker, vous pouvez écrire des applications ou des scripts d'automatisation pour provisionner de nouveaux comptes utilisateur Looker, exécuter des requêtes, planifier des rapports, etc. À peu près tout ce que vous pouvez faire dans l'application Looker, que vous pouvez faire via l'API Looker.

Chemin et port de l'API Looker

Accédez à l'API de votre instance Looker via son URL.

Votre administrateur Looker peut spécifier un chemin d'accès à l'API en le saisissant dans le champ URL de l'hôte de l'API de la page Administration > API dans l'un des formats suivants:

https://<instance_name>.api.looker.com

ou :

https://<instance_name>.api.<my_region>.looker.com

ou :

https://<instance_name>.looker.com

Votre administrateur Looker peut également utiliser le champ URL de l'hôte de l'API pour attribuer un chemin d'accès à l'API différent de celui de votre serveur Looker. Cette situation est fréquente lorsque votre installation de Looker se trouve derrière un équilibreur de charge, par exemple. Dans ce cas, contactez votre administrateur Looker pour obtenir votre chemin d'accès à l'API.

Si votre administrateur Looker n'a pas spécifié le champ URL de l'hôte de l'API, Looker utilise le chemin d'accès par défaut de l'API. Pour les instances Looker hébergées sur Google Cloud, Microsoft Azure et les instances hébergées sur Amazon Web Service (AWS) créées à partir du 07/07/2020, le chemin d'accès par défaut de l'API Looker utilise le port 443. Pour les instances Looker hébergées sur AWS et créées avant le 07/07/2020, le chemin d'accès à l'API Looker par défaut utilise le port 19999. L'URL par défaut de l'API est au format suivant:

https://<instance_name>.looker.com:<port>

Les URL d'API ci-dessus se connectent à la version 3.1 de l'API par défaut. Vous pouvez également vous connecter à la version 3.0 de l'API, qui a été abandonnée, en la spécifiant dans l'URL au format https://<instance_name>.looker.com:<port>/api/3.0/user ou https://<instance_name>.api.looker.com/api/3.0/user.

SDK client

Vous pouvez utiliser l'API Looker avec n'importe quel langage de programmation ou environnement d'application pouvant effectuer des requêtes HTTPS et traiter des réponses JSON. Vous pouvez créer des requêtes HTTPS pour l'API Looker manuellement à l'aide de curl (ou équivalent), à l'aide du SDK Ruby pour Looker ou en générant une bibliothèque de SDK client pour le langage de votre choix. Nous vous recommandons d'utiliser un SDK, car il se charge des détails de l'authentification et des requêtes HTTPS pour vous, ce qui vous permet d'appeler l'API Looker à l'aide d'appels de fonction simples.

Vous trouverez des informations détaillées sur le SDK sur notre page de documentation sur les SDK de l'API Looker.

Authentification

Looker authentifie les requêtes API à l'aide d'un jeton d'accès au support OAuth 2.0 dans l'en-tête d'autorisation HTTP de la requête. Tous les points de terminaison de l'API Looker nécessitent une connexion HTTPS sécurisée afin que le jeton d'accès soit sécurisé en transit.

La procédure à suivre varie selon que vous utilisez ou non un SDK. Des instructions détaillées sont disponibles sur la page de l'authentification de l'API Looker.

Documentation interactive de l'API

Pour consulter la documentation de référence de l'API, vous pouvez accéder à l'extension API Explorer à partir de Looker Marketplace. Pour en savoir plus, consultez la page Utiliser l'explorateur d'API. Si vous êtes un administrateur Looker, vous pouvez également accéder à l'explorateur d'API en cliquant sur le lien Utiliser l'explorateur d'API sur la page d'administration de l'API de Looker.

Si vous n'avez pas accès à une instance Looker sur laquelle API Explorer est installé, vous pouvez afficher une version publique sur le portail des développeurs de Looker.

Gestion des versions

La stabilité des API est un point important à prendre en compte lorsque vous créez des applications. Pour vous aider à identifier les points de terminaison qui sont susceptibles d'être modifiés à l'avenir et ceux qui doivent rester stables, nous marquons certains points de terminaison comme étant en version bêta. Pour en savoir plus, consultez la page de documentation sur la gestion des versions de l'API Looker.