Premiers pas avec l'API Looker

L'API Looker est une interface de programmation d'applications RESTful sécurisée permettant de gérer l'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 créer de nouveaux comptes utilisateur Looker, exécuter des requêtes, planifier des livraisons de données, etc. Quasiment toutes les tâches réalisables dans l'application Looker s'effectuent via l'API Looker.

Chemin d'accès et port de l'API Looker

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

Votre administrateur Looker peut spécifier un chemin d'API en le saisissant dans le champ URL de l'hôte de l'API sur la page Admin > API au format suivant :

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

Votre administrateur Looker peut également utiliser le champ URL de l'hôte de l'API pour attribuer un chemin d'API différent du nom de la machine de votre serveur Looker. Cela est courant lorsque votre installation 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 à l'API par défaut. 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 le 07/07/2020 ou après, le chemin d'accès par défaut à 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 par défaut à l'API Looker utilise le port 19999. L'URL de l'API par défaut se présente au format suivant :

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

SDK clients

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

Vous trouverez des informations sur les SDK sur la page de documentation SDK de l'API Looker.

Authentification

Looker authentifie les requêtes d'API à l'aide d'un jeton d'accès 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 dépend de l'utilisation ou non d'un SDK. Pour obtenir des instructions détaillées, consultez la page de documentation Authentification de l'API Looker.

Documentation interactive de l'API

Pour la documentation de référence de l'API, l'extension API Explorer est disponible sur la place de marché Looker. Pour en savoir plus, consultez la page de documentation Utiliser l'explorateur d'API. Si vous êtes 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 API de Looker.

Gestion des versions

La stabilité des API est un élément important à prendre en compte lors de la création d'applications. Pour vous aider à identifier les points de terminaison qui pourront être modifiés à l'avenir et ceux qui devraient rester stables, nous indiquons que certains points de terminaison sont en version bêta. Pour en savoir plus, consultez la page de documentation sur le versioning de l'API Looker.