DataService Studio vous permet de concevoir, publier et gouverner des API de données sans écrire de service backend. Connectez-vous à une source de données, configurez la logique de requête et exposez le résultat sous forme d'API REST appelable, le tout directement depuis DataWorks.
Utilisez la gestion des API lorsque vous devez fournir aux applications ou équipes en aval un accès contrôlé et à la demande à des jeux de données spécifiques. Pour les transferts de données massifs ou les exportations à grande échelle, privilégiez plutôt les solutions de synchronisation de données.
Public cible
La gestion des API couvre deux workflows distincts selon votre rôle :
Éditeurs d'API — ingénieurs ou analystes de données qui créent des API adossées à une source de données, les testent, les publient et contrôlent les droits d'appel.
Consommateurs d'API — développeurs d'applications ou utilisateurs de données qui découvrent les API publiées, demandent une autorisation et intègrent ces API dans leurs applications.
Publier une API
Suivez ces étapes pour construire et publier une API de données :
Créez une API. Générez une API à partir d'une source de données en utilisant l'interface sans code (aucune compétence SQL requise) ou l'éditeur de code (pour les requêtes SQL personnalisées). Vous pouvez également enregistrer un service HTTP/HTTPS externe existant afin de le gérer de manière centralisée dans DataService Studio.
Testez l'API. Effectuez des appels de test sur l'API avant sa publication afin de vérifier la logique de requête, la gestion des paramètres et le format de la réponse.
Publiez l'API. Publiez l'API pour la rendre appelable. Gérez les versions afin de pouvoir revenir à une version précédente si nécessaire.
Autorisez les appelants. Accordez à des applications ou des utilisateurs spécifiques l'autorisation d'appeler l'API publiée.
Appeler une API
Suivez ces étapes pour intégrer une API publiée dans votre application :
Découvrez l'API. Parcourez les API disponibles dans le catalogue de services de DataService Studio et identifiez celle qui répond à votre besoin en données.
Demandez une autorisation. Contactez l'éditeur de l'API pour obtenir la permission d'appel pour votre application.
Appelez l'API. Utilisez les informations d'identification d'autorisation pour envoyer des requêtes à l'endpoint de l'API depuis votre application.
Fonctionnalités disponibles
|
Tâche |
Description |
|
Générer des API à partir d'une source de données |
Créez une API REST adossée à une table de base de données ou à une requête SQL, en utilisant soit l'interface sans code, soit l'éditeur de code |
|
Enregistrer un service API externe |
Importez une API HTTP/HTTPS existante dans DataService Studio pour une publication et une gouvernance centralisées |
|
Tester, publier et gérer les versions |
Effectuez des appels de test, publiez l'API pour la rendre appelable et gérez les versions pour permettre les retours arrière |
|
Autoriser une API |
Accordez à des applications spécifiques l'autorisation d'appeler une API publiée |
|
Appeler une API |
Envoyez des requêtes authentifiées à un endpoint d'API publié |
|
Configurer des filtres d'API |
Appliquez des préfiltres et des postfiltres à l'aide de fonctions Aviator ou Python pour prétraiter les paramètres de requête ou transformer les réponses de l'API |
|
Gérer et maintenir les API |
Surveillez les journaux d'appels, mettez à jour la configuration de l'API, mettez une API hors ligne et organisez les API avec des libellés |