connexion à REST API

Avant de commencer

Copy link to section

Procédure

Copy link to section

Pour vous connecter à REST API en Data Virtualization, procédez comme suit.

1. Dans le menu de navigation, cliquez sur Données > Data virtualization La page Sources de données s’affiche.

2. Cliquez sur Ajouter une connexion > Nouvelle connexion pour afficher la liste des sources de données.

3. Sélectionnez la connexion à la source de données REST API.

4. Entrez le nom et la description de la connexion.

5. Saisissez l' URL e de votre base de données hôte. Vous avez le choix entre deux méthodes pour établir une connexion à la source de données d' REST API : la méthode de la propriété Sample et la méthode du fichier Model.

   Méthode de la propriété d'échantillon

   Si vous utilisez la méthode de propriété Sample, spécifiez un point de terminaison pour votre nom d'hôte, comme dans cet exemple URL : https://domain.example.com/api/v1/employee_name. La méthode de propriété Sample permet d'accéder aux données à partir d'un seul point d'extrémité avec une configuration minimale. Vous n'avez pas besoin de fournir un fichier modèle.

   Méthode du fichier modèle

   • Si vous utilisez la méthode du fichier modèle, saisissez l' URL e de base de votre nom d'hôte (https://domain.example.com) pour permettre l'accès aux données à partir de plusieurs points de terminaison.
   • Pour cette méthode, vous devez créer manuellement le fichier Modèle, puis le coller dans le champ Fichier modèle. Pour créer votre fichier modèle et mapper vos points de terminaison aux tables, suivez les étapes de la section Syntaxe du fichier modèle Pour connaître le format de base de la mise en correspondance des points finaux avec les tables, voir l'exemple dans Création d'un fichier modèle.
   • Vous pouvez modifier votre fichier modèle pour l'adapter à votre environnement, par exemple la manière dont le pilote traite les codes d'état d' HTTP s ou les différentes configurations pour les requêtes GET. Pour la source de données REST API , vous n'avez pas besoin d'une requête POST ou d'un objet d'authentification comme indiqué dans le fichier modèle Exemple.

6. Effectuez l'une des tâches suivantes.

   • Utilisation de l'authentification par clé API configurée comme paramètre de requête

     Pour utiliser l'authentification par clé API, assurez-vous que votre source de données prend en charge le passage de clé API en tant que paramètre de requête avant de suivre ces étapes.

     1. Pour utiliser l'authentification par clé API, ajoutez la clé API directement à l' URL. hôte.
        Par exemple : Dans cet exemple URL, vous remplaceriez <your_api_key> par la clé API.

        https://api.example.com/resource?apikey=<your_api_key>

     2. Dans Identifiants, sélectionnez Aucun comme méthode d'authentification.

     Utilisation de l'authentification par clé API configurée comme paramètre d'en-tête

     Pour utiliser l'authentification par clé API configurée en tant que paramètre d'en-tête, procédez comme suit.

     1. Dans le champ Propriétés supplémentaires, saisissez le paramètre suivant. Remplacez <your_api_key> par la clé API.

        AuthenticationMethod=HttpHeader;SecurityToken=ApiKey<your_api_key>
        Copy to clipboardCopié dans le presse-papiers

     2. Dans Identifiants, sélectionnez Aucun comme méthode d'authentification.

     Utilisation d'autres méthodes d'authentification (de base, aucune ou jeton de porteur)

     Pour utiliser d'autres méthodes d'authentification, terminez cette étape.

     1. Dans Identifiants, sélectionnez votre méthode d'authentification (Basique, Aucune ou Jeton porteur) et fournissez les identifiants requis.

7. Si la connexion nécessite un certificat SSL personnalisé, saisissez le certificat dans le champ Certificat SSL.

8. Cliquez sur Créer pour ajouter la connexion à l'environnement de source de données.

Résultats

Copy link to section