Nous avons le plaisir de vous annoncer que l'API Looker 4.0 est disponible pour tous dans Looker 22.4. L'API 4.0 (API 4.0 GA) accessible à tous 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 les API pour obtenir des spécifications détaillées sur l'API 4.0. Nous avons mis à jour nos kits SDK pris en charge par Looker et la communauté pour prendre en charge les points de terminaison de l'API 4.0 Looker accessible à tous. Pour en savoir plus, consultez les Règles concernant l'assistance pour les API et les SDK et le versionnage des API. Le reste de cet article décrit les modifications destructives, les atténuations et les fonctionnalités que vous pouvez attendre lors de la migration vers l'API 4.0 en disponibilité générale.
À qui s'adresse ce guide ?
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 avant la disponibilité générale
Si vous utilisez l'API 4.0, lisez cette section. Il couvre les modifications majeures et les solutions disponibles lorsque vous migrez vers l'API 4.0 en disponibilité générale.
La version GA de l'API 4.0 inclut la modification de tous les champs d'ID d'entité, qui passent du type numérique integer
au type string
. 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 ci-dessous pour connaître l'impact et les atténuations 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 | Invitez les utilisateurs à passer à la dernière version de l'application mobile Looker. |
SDK 2 compatibles avec Looker | ||
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 compatibles avec 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. |
Autre | ||
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é aux types du langage | Examinez le code pour identifier les dépendances sur le type des champs d'ID et ajoutez la compatibilité avec les champs d'ID de type chaîne. Consultez également ces conseils supplémentaires. |
1 : En supposant des schémas d'utilisation courants qui peuvent inclure l'utilisation des champs d'ID de Looker, mais pas des schémas d'utilisation inhabituels tels que l'application d'opérations numériques aux ID.
2) Assistance pour 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 les 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 listons les modifications les plus notables et les plus utiles de l'API 4.0 :
- Création et gestion de tableaux, d'éléments de tableau et de sections de tableau 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 des applications et des utilisateurs OAuth. Pour en savoir plus sur OAuth, consultez la page de documentation OAuth.
- Recherchez des groupes avec hiérarchie et rôles.
- Recherchez des rôles avec le nombre d'utilisateurs.
- Obtenez et définissez les paramètres d'instance Looker. Pour en savoir plus sur les paramètres, consultez la page de documentation sur les paramètres.
- Création et gestion des alertes : Pour en savoir plus sur les alertes, consultez la page de documentation sur les alertes.
- Création, gestion et test des tunnels et serveurs SSH Pour en savoir plus sur SSH, consultez la page de documentation SSH.
- Déplacez et copiez des tableaux de bord.
- Obtenez des URL relatives pour les nouveaux tableaux de bord.
- Déplacez et copiez des présentations.
- Intégration signée, secret d'intégration non signé, URL, création et gestion des utilisateurs.
- Obtenez un jeton d'actualisation pour actualiser le jeton d'accès à la connexion.
- Limitez et décallez les résultats pour obtenir tous les modèles LookML et tous les utilisateurs.
- Limitez et décallez les résultats de la recherche des utilisateurs.
- Obtenez la spécification de l'API de l'instance Looker au format JSON Swagger 2.x.
Modifications apportées à l'abandon de l'API 4.0 en disponibilité générale
L'API 4.0 GA 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 obsolètes de la page d'accueil ont été supprimés. Veuillez utiliser les points de terminaison du tableau au lieu des pages d'accueil. Consultez Présenter du contenu à l'aide de tableaux.
- Les points de terminaison Spaces 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 migrer vers 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 sur cette page.
Conclusion
De nouvelles fonctionnalités et des modifications seront ajoutées à 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 Règles concernant l'assistance pour les API et les SDK et le versionnage 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 l'API 4.0 de Looker, désormais disponible pour tous, vous aidera à développer plus facilement et de manière plus productive sur la plate-forme Looker.