Nous avons le plaisir de vous annoncer que l'API Looker 4.0 est disponible pour tous les utilisateurs de Looker 22.4. L'API 4.0 accessible à tous (API 4.0 GA) comprend de nouveaux ajouts et suppressions qui font passer plusieurs points de terminaison de la version bêta à la version stable. Consultez notre documentation de référence sur l'API pour obtenir des spécifications détaillées de l'API 4.0. Nous avons mis à jour nos SDK pris en charge par Looker et la communauté pour qu'ils prennent en charge les points de terminaison de l'API 4.0 Looker accessible à tous. Pour en savoir plus, consultez les pages Règles de prise en charge des API et des SDK et Gestion des versions des API. Le reste de cet article décrit les modifications destructives, les mesures d'atténuation et les fonctionnalités que vous pouvez attendre lorsque vous migrez vers la version GA de l'API 4.0.
À qui s'adresse ce document ?
Ce document s'adresse à vous si vous utilisez l'API Looker via des SDK compatibles avec Looker, des SDK compatibles avec la communauté ou l'API elle-même. Lisez la section suivante qui correspond à la version de l'API Looker que vous utilisez.
Utilisateurs de l'API 4.0 en version pré-GA
Si vous utilisez l'API 4.0, lisez cette section. Il décrit les modifications majeures et les solutions disponibles lorsque vous passez à l'API 4.0 GA.
La version GA de l'API 4.0 remplace le type numérique integer
par le type string
pour tous les champs d'ID d'entité. Par exemple, le point de terminaison GET /groups/{group_id}
renvoie id
en tant que type string
au lieu du type int64
.
Veuillez consulter le tableau suivant pour connaître l'impact et les mesures d'atténuation spécifiques à votre utilisation des points de terminaison de l'API 4.0:
Utilisation | Impact potentiel1 | Prévention |
Applications mobiles Looker | Les installations obsolètes des applications mobiles Looker ne fonctionnent plus | Demander aux utilisateurs de passer à la dernière version de l'application mobile Looker |
SDK compatibles avec Looker2 | ||
SDK TypeScript (API 4.0) | Aucun impact | Aucune action requise |
SDK Python (API 4.0) | Aucun impact | Aucune action requise |
SDK Ruby (API 4.0) | Aucun impact | Aucune action requise |
SDK 2 pris en charge par la communauté | ||
SDK Swift | Exceptions d'exécution | Mettez à jour le SDK vers la version 22.0 ou ultérieure, puis corrigez les erreurs de type qui en résultent, le cas échéant. |
SDK Kotlin | Aucun impact | Aucune action requise |
SDK LookR | Aucun impact | Aucune action requise |
SDK C# | Aucun impact | Aucune action requise |
SDK Go | Exceptions d'exécution | Mettez à jour le SDK vers la version 22.0 ou ultérieure, puis corrigez les erreurs de type qui en résultent, le cas échéant. |
Other | ||
Utiliser l'API 4.0 sans SDK (ou avec des bibliothèques fournies en externe) | Erreurs d'exécution possibles, en fonction de la sensibilité du type de langage | Examinez le code pour détecter les dépendances sur le type de champs d'ID et ajoutez la prise en charge des champs d'ID de type chaîne. Consultez également ces conseils supplémentaires. |
1: en supposant des modèles d'utilisation courants qui peuvent inclure l'utilisation des champs d'ID de Looker, mais pas des modèles d'utilisation inhabituels tels que l'application d'opérations numériques aux ID.
2: Compatibilité avec l'API et le SDK Looker Les bibliothèques prises en charge par la communauté ne sont pas officiellement compatibles avec Looker.
Utilisateurs de l'API 3.1
Si vous utilisez l'API 3.1, lisez cette section. Il couvre les fonctionnalités et modifications supplémentaires que l'API 4.0 met à votre disposition. N'oubliez pas que tous nos SDK pris en charge par Looker et la communauté sont principalement compatibles avec l'API 4.0. Pour en savoir plus, consultez les Règles d'assistance pour les SDK et les API.
Fonctionnalités supplémentaires de l'API 4.0 en disponibilité générale
Pour plus de commodité, nous vous listons les modifications les plus notables et utiles de l'API 4.0:
- Création et gestion de tableaux, d'éléments et de sections de tableaux Pour en savoir plus sur les tableaux, consultez la page de documentation sur les tableaux.
- Interrogez des informations de connexion supplémentaires telles que les bases de données, les schémas, les colonnes et les tables. Définissez et mettez à jour d'autres champs de connexion.
- Création et gestion d'applications et d'utilisateurs OAuth. Pour en savoir plus sur OAuth, consultez la page de documentation OAuth.
- Recherchez des groupes avec une hiérarchie et des rôles.
- Rechercher des rôles avec le nombre d'utilisateurs
- Obtenez et définissez les paramètres de l'instance Looker. Pour en savoir plus sur les paramètres, consultez la page de documentation sur les paramètres.
- Création et gestion d'alertes Pour en savoir plus sur les alertes, consultez la page de documentation sur les alertes.
- Création, gestion et test de tunnels et de serveurs SSH Pour en savoir plus sur le protocole SSH, consultez la page de documentation SSH.
- Déplacer et copier des tableaux de bord
- Obtenir des URL relatives pour les nouveaux tableaux de bord
- Déplacer et copier des présentations.
- Inclusion intégrée signée et non signée, secret d'intégration, URL, création et gestion des utilisateurs.
- Obtenir un jeton d'actualisation pour actualiser le jeton d'accès de connexion
- Limitez et décalez les résultats obtenus en récupérant tous les modèles LookML et tous les utilisateurs.
- Limitez et décalez les résultats des recherches des utilisateurs.
- Obtenez la spécification de l'API d'instance Looker au format JSON Swagger 2.x.
Modifications apportées à l'API 4.0 GA lors de son abandon
La version GA de l'API 4.0 remplace plusieurs points de terminaison de l'API 3.1 obsolètes par des fonctionnalités améliorées. Les points de terminaison suivants sont concernés:
- Les points de terminaison de la page d'accueil obsolètes ont été supprimés. Veuillez utiliser les points de terminaison de tableau au lieu des pages d'accueil. Consultez Présenter du contenu à l'aide de tableaux.
- Les points de terminaison Space obsolètes ont été supprimés. Utilisez des points de terminaison de dossier au lieu d'un espace. Consultez Organiser et gérer l'accès au contenu.
Utilisateurs de l'API 3.0
L'API 3.0 est obsolète. Nous vous recommandons de passer à l'API 4.0.
- Seule l'API 4.0 est compatible avec tous les SDK pris en charge par Looker et la communauté pour faciliter votre développement. Consultez notre dépôt de SDK.
- L'API 4.0 introduit plusieurs nouvelles fonctionnalités et améliorations, comme indiqué dans la section Fonctionnalités supplémentaires de l'API 4.0 en disponibilité générale de cette page.
Conclusion
Vous pouvez vous attendre à de nouvelles fonctionnalités et à des modifications supplémentaires dans l'API 4.0. Vous trouverez toujours les dernières modifications dans notre documentation de référence de l'API. Pour en savoir plus, consultez les pages Règles de prise en charge des API et des SDK et Gestion des versions des API. Nous savons que les modifications importantes ne sont pas idéales. Sauf en cas de problème extrême, nous n'apporterons aucune modification destructive à notre API 4.0 en disponibilité générale. Nous espérons que notre API Looker 4.0, disponible pour tous, vous aidera à développer plus facilement et plus efficacement des applications sur la plate-forme Looker.