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 en disponibilité générale) est disponible pour tous les utilisateurs. Elle comporte plusieurs modifications destructives et additives, et favorise plusieurs points de terminaison de la version bêta à la version stable. Les API 3.1 et 3.0 ne sont pas concernées. Consultez la documentation de référence de l'API pour en savoir plus sur les spécifications détaillées de l'API 4.0. Nous avons mis à jour nos SDK compatibles avec Looker et la communauté pour qu'ils soient compatibles avec les points de terminaison GA de l'API 4.0. Pour en savoir plus, consultez nos Règles de compatibilité avec les API et les SDK, ainsi que la version de nos API. Le reste de cet article décrit les modifications destructives, les stratégies d'atténuation et les fonctionnalités que vous pouvez espérer lorsque vous migrez vers l'API 4.0 en disponibilité générale.
Qui doit lire ceci ?
Ce document vous concerne si vous utilisez l'API Looker via les SDK compatibles avec Looker, les SDK compatibles avec la communauté ou l'API elle-même. Veuillez lire la section suivante, qui correspond à la version de l'API Looker que vous utilisez actuellement.
Utilisateurs de l'API Pre-GA 4.0
Si vous utilisez l'API 4.0, consultez cette section. Il aborde les modifications destructives et les mesures d'atténuation disponibles lorsque vous migrez vers l'API 4.0 GA sur Looker 22.4.
L'API GA 4.0 inclut la modification du champ numérique d'entité integer
en string
. Par exemple, GET /groups/{group_id}
point de terminaison renvoie id
comme type string
au lieu de type int64
.
Veuillez consulter le tableau suivant pour connaître l'impact et les mesures d'atténuation spécifiques à votre utilisation du point de terminaison de l'API 4.0:
Utilisation | Impact potentiel1 | Prévention |
Applications mobiles Looker | Les installations obsolètes des applications mobiles Looker cessent de fonctionner | Demander aux utilisateurs d'installer la dernière version des applications mobiles Looker |
Compatibles avec2 SDK | ||
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 compatibles avec la communauté2 | ||
SDK Swift | Exceptions d'exécution | Mettre à jour le SDK vers la version 22.0 ou ultérieure, puis résoudre les erreurs de type obtenues, le cas échéant |
SDK Kotlin | Aucun impact | Aucune action requise |
SDK Looker | Aucun impact | Aucune action requise |
SDK C# | Aucun impact | Aucune action requise |
SDK Go | Exceptions d'exécution | Mettre à jour le SDK vers la version 22.0 ou ultérieure, puis résoudre les erreurs de type obtenues, 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 langue | Examinez le code pour les dépendances sur le type des champs d'ID et ajoutez la prise en charge des champs d'ID de type chaîne. Consultez également ces conseils supplémentaires. |
1: adopter des modèles d'utilisation courants pouvant 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 une communauté ne sont pas officiellement compatibles avec Looker.
Utilisateurs de l'API 3.1
Si vous utilisez l'API 3.1, consultez cette section. Il aborde les fonctionnalités et les modifications supplémentaires disponibles dans l'API 4.0. N'oubliez pas que tous nos SDK compatibles avec Looker et avec la communauté sont principalement compatibles avec l'API 4.0. Pour en savoir plus, consultez nos Règles de compatibilité avec les SDK et les API.
Autres fonctionnalités de l'API 4.0 en disponibilité générale
Pour vous aider, nous avons dressé la liste des modifications les plus importantes et les plus utiles apportées à l'API 4.0:
- Création et gestion de tableaux, d'éléments de tableau et de sections du tableau : Pour accéder à la documentation du board, cliquez ici.
- Interrogez des informations de connexion supplémentaires telles que des bases de données, des schémas, des colonnes et des tables. Définissez et mettez à jour des champs de connexion supplémentaires.
- Création et gestion d'applications et de comptes utilisateur OAuth La documentation OAuth est disponible sur cette page.
- Recherchez des groupes avec hiérarchie et rôles.
- Rechercher des rôles avec le nombre d'utilisateurs
- Obtenez et définissez les paramètres d'instance Looker. Pour consulter la documentation sur les paramètres, cliquez ici.
- Création et gestion des alertes : Pour consulter la documentation sur les alertes, cliquez ici.
- Créer et gérer des tunnels et des serveurs SSH à l'aide de tunnels SSH La documentation SSH est disponible sur cette page.
- Déplacer et copier des tableaux de bord
- Obtenez les URL relatives pour les nouveaux tableaux de bord.
- Déplacer et copier des looks.
- L'authentification unique et l'intégration d'un secret, l'URL, ainsi que la création et la gestion des utilisateurs.
- Obtenir un jeton d'actualisation pour actualiser le jeton d'accès à la connexion
- Limiter et compenser les résultats de l'obtention de tous les modèles LookML et tous les utilisateurs.
- Limiter et compenser les résultats des recherches d'utilisateurs
- Obtenir les spécifications de l'API de l'instance Looker dans le fichier JSON Swagger 2.x
Modifications apportées à l'abandon de l'API 4.0 en disponibilité générale
L'API GA 4.0 remplace plusieurs points de terminaison de l'API 3.1 obsolètes par des fonctionnalités améliorées. Voici la liste des points de terminaison concernés:
- Les points de terminaison obsolètes de la page d'accueil ont été supprimés. Veuillez utiliser des points de terminaison de tableau au lieu de pages d'accueil. Pour accéder à la documentation sur les fonctionnalités du tableau, cliquez ici.
- Les points de terminaison obsolètes de l'espace ont été supprimés. Veuillez utiliser des points de terminaison de dossier au lieu de l'espace. Pour consulter la documentation sur les fonctionnalités de dossier, cliquez ici.
Utilisateurs de l'API 3.0
Si vous utilisez l'API 3.0, consultez cette section. N'oubliez pas que l'API 3.0 est considérée comme ancienne et obsolète. Nous vous déconseillons de l'utiliser. Nous vous encourageons à migrer vers l'API 4.0.
- Seule l'API 4.0 est compatible avec tous les SDK compatibles avec Looker et la communauté pour faciliter votre développement. Consultez notre dépôt du SDK.
- L'API 4.0 introduit plusieurs nouvelles fonctionnalités et améliorations, comme indiqué ci-dessus.
Synthèse
De nouvelles fonctionnalités et des ajouts seront ajoutés à l'API 4.0. Pour consulter les dernières modifications, consultez la documentation de référence de l'API. Pour en savoir plus, consultez les Règles concernant la compatibilité des API et des SDK, ainsi que la version de nos API. Nous savons que les modifications destructives ne sont pas idéales. Sauf en cas de problème extrême, nous n'apporterons aucune modification destructive à notre API en disponibilité générale 4.0. Nous espérons que notre API 4.0 en disponibilité générale vous aidera à développer votre application plus facilement et de façon plus productive sur la plate-forme Looker.