Personnaliser votre API

Cette page est réservée aux utilisateurs qui souhaitent personnaliser un Profil API afin de répondre à leurs besoins spécifiques.

Par personnalisation, nous entendons la possibilité soit de créer un Profil API à partir de zéro, soit de modifier un profil existant en ne récupérant que les données qui vous intéressent.

Ces données utilisent les valeurs (Clés) des Attributs pour construire et définir les Colonnes de la Table.

Dans les deux cas, vous devez lier votre Profil API au Fournisseur API par le biais de son adresse URI.

Prérequis

Avant de commencer, assurez-vous que vous avez un logiciel d'archivage de fichiers tel que WinZip, 7-zip ou Winrar installé sur votre ordinateur pour extraire les Tables du Profil API.

Paramétrer Postman

Une fois Postman installé, ouvrez Postman et faites ce qui suit :

1. Dans le coin supérieur droit, cliquez sur l'icône des paramètres (clé) et sélectionnez Settings.
   
2. Sous l'onglet General, dans le champ Max Response Size in MB, entrez 0 comme valeur, afin que Postman puisse récupérer des données de taille illimitée.
   
3. Cliquez sur le X pour enregistrer votre changement.

Comprendre la structure des fichiers .rsd

Avant de créer le Profil API personnalisé, nous devons d'abord comprendre de quels éléments ce fichier est composé.

Cliquez ici pour révéler la structure

<api:script> <api:info> <attr/> </api:info> <api:set attr="ContentType" value="application/json" /> <api:script method="GET" > <api:set attr="method" /> <api:set attr="uri" /> <api:set attr="RepeatElement" /> <api:set/> <api:call> <api:push/> </api:call> </api:script> </api:script>

<api:script xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:api="http://apiscript.com/ns?v1" >

<api:info xmlns:other="http://apiscript.com/ns?v1" title="Covid19" desc="Get all the Covid">
     <attr name="Country"               xs:type="string"  	readonly="true"     other:xPath="Country"/>
     <attr name="Confirmed"             xs:type="integer" 	readonly="true"     other:xPath="Confirmed"/>
     <attr name="Date"                  xs:type="datetime"     readonly="true"     other:xPath="Date"/>
</api:info>

<api:script method="GET" >

<!-- For the HTTP Method -->		
  <api:script method="GET" >
    <api:set attr="method" value="GET" />
  <!-- To define the source (URL) from which the data come from --> 
    <api:set attr="uri" value="https://api.covid19api.com/all" />

    <api:call op="apisadoExecuteJSONGet">
      <api:push/>
    </api:call>
  </api:script>

Créer un Profil API personnalisé

Dans ce document, deux cas de création d'API seront abordés en fonction de leur niveau de difficulté, c'est-à-dire, de la manière dont les Attributs sont imbriqués.

• Pour le cas simple, les données relatives au coronavirus COVID-19 de l'API Covid19 seront utilisées, car l'arborescence est facile à comprendre et simple (c'est-à-dire, que les Attributs sont au niveau de la Racine) pour construire et consolider votre base de connaissances.
• Pour le cas avancé, les données relatives au Change de Devises Étrangères (ForEX)de l'API Alphavantage seront utilisées pour découvrir ce qui est impliqué lorsque les Attributs ne sont pas au niveau de la Racine.

Étapes et Informations Communes

1. Ouvrez un éditeur de texte tel que Notepad et copiez-collez les lignes suivantes dans votre document :
   

   <api:script xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:api="http://apiscript.com/ns?v1" >
   <api:info xmlns:other="http://apiscript.com/ns?v1" title="A Title" desc="A Description">

2. Pour les valeurs title et desc, saisissez un titre et une description (de préférence en rapport avec les informations que vous souhaitez récupérer de l'API).
3. Enregistrez votre document en tant que fichier .rsd.

4. Allez à la section documentation du Fournisseur API. Dans le cas présent, il s'agit de l'API Covid19.
5. Copiez l'adresse URI qui contient les données qui vous intéressent. Dans cet exemple, All Data (https://api.covid19api.com/all) est choisie pour que toutes les données puissent être récupérées.
   
6. Dans Postman, cliquez sur le + à côté de l'onglet Launchpad pour en créer un.
   
7. Dans le champ GET , collez l'adresse URI et cliquez sur Send.
   
8. Comme vous pouvez le voir sur la capture d'écran ci-dessous, les Attributs sont accessibles directement à partir de la Racine, c'est-à-dire, qu'il n'y a pas de nom d'élément avant le signe "{".
   
9. De retour à votre Notepad, ajoutez la ligne suivante pour créer les colonnes du tableau.
   

        <attr name="X"               		xs:type="X"  	readonly="true"     other:xPath="X"/>

10. Pour faciliter la définition des valeurs, placez Postman sur l'un des côtés de votre écran et le Notepad sur l'autre côté.
    
11. Remplacez les valeurs X comme suit :

12. Dupliquez cette ligne pour ajouter autant d'Attributs que vous le souhaitez et modifiez les valeurs en fonction de leur Type de Données, comme indiqué dans le tableau en dessus.
13. Une fois votre liste d'Attributs terminée, clôturez-la en ajoutant la balise </api:info>.

14. Copiez et collez cette ligne dans votre Notepad pour configurer les Paramètres Globaux.
    

    <api:set attr="ContentType" value="application/json" />

15. Copiez et collez les lignes suivantes pour définir la Méthode de Script qui sera utilisée.
    

    <api:script method="GET" >
        <api:set attr="method" value="GET" />
    	<api:set attr="uri" value="X" />
        <api:set attr="RepeatElement" value="X" />

16. Remplacez les valeurs X comme suit :

17. Copiez et collez les lignes suivantes dans votre Notepad pour terminer la création de votre API Personnalisée.
    

    <api:call op="apisadoExecuteJSONGet">
          <api:push/>
        </api:call>
      </api:script>
     </api:script>

18. Une fois le fichier .rsd complété :
    1. Suivez la procédure décrite dans Paramètres pour Custom API pour créer et configurer une nouvelle Connexion (voir Authentifications pour plus de détails).
    2. Suivez la procédure décrite dans Ajouter une Extraction et Configurer le Panneau Extraction pour définir l'extraction.
    3. Suivez la procédure décrite dans Lancer une Extraction pour récupérer les données.

Étapes Spécifiques à un Cas Avancé

Pour cette section, nous utilisons les données relatives au Change de Devises Étrangères (ForEX) de l'API Alphavantage car les Attributs ne sont pas au niveau de la Racine.

Cette section est composée de deux exemples : le premier concerne la récupération de données à partir d'un RepeatElement qui n'est pas au niveau de la Racine et le second concerne la récupération de données lorsque le RepeatElement est une Variable.

Premier Exemple

1. Répétez les étapes décrites dans Étapes et Informations Communes jusqu'à l'étape 7.
2. Comme vous pouvez le voir sur la capture d'écran ci-dessous, les Attributs ne sont pas accessibles directement à partir de la Racine, c'est-à-dire, qu'il y a un nom d'élément avant le signe "{". Dans ce cas, le nom de l'élément est Realtime Currency Exchange Rate.
   
3. Suivez les étapes décrites dans Étapes et Informations Communes partir de l'étape 9 jusqu'à la fin pour créer votre Profil API.
4. Pour la balise api:set attr="RepeatElement" value="X", remplacez le X par la valeur qui est placée avant le signe "{" dans le format suivant : /valeur/. Dans ce cas, il s'agit de Realtime Currency Exchange Rate.
5. Si les Attributs comportent des caractères spéciaux tels qu'un trait de soulignement, des espaces ou des mots avec des accents, placez la valeur telle quelle entre crochets [] dans la section other:xPath.

Dans Postman	Devient	Dans Notepad
	=	other:xPath="[1. From_Currency Code]"/> other:xPath="[2. From_Currency Name]"/> other:xPath="[3. To_Currency Code]"/> other:xPath="[4. To_Currency Name]"/> other:xPath="[5. Exchange Rate]"/> other:xPath="[6. Last Refreshed]"/> other:xPath="[7. Time Zone]"/>

6. Une fois le fichier .rsd complété :
   1. Suivez la procédure décrite dans Paramètres pour Custom API pour créer et configurer une nouvelle Connexion (voir Authentifications pour plus de détails).
   2. Suivez la procédure décrite dans Ajouter une Extraction et Configurer le Panneau Extraction pour définir l'extraction.
   3. Suivez la procédure décrite dans Lancer une Extraction pour récupérer les données.

Deuxième Exemple

Dans cette section, nous expliquons comment récupérer des données qui ne sont pas au niveau de la Racine et lorsque le RepeatElement est une Variable.

1. Répétez les étapes décrites dans Étapes et Informations Communes jusqu'à l'étape 7.
2. Comme vous pouvez le voir sur la capture d'écran ci-dessous, les Attributs ne sont pas accessibles directement à partir de la Racine, c'est-à-dire, qu'il y a un nom d'élément avant le signe "{", suivi de dates aléatoires (agissant comme une Variable, car ils sont incrémentés automatiquement). Dans ce cas, le nom de l'élément est Time Series FX (Daily).
   
3. Suivez les étapes décrites dans Étapes et Informations Communes partir de l'étape 9 jusqu'à la fin pour créer votre Profil API.
4. Pour la balise api:set attr="RepeatElement" value="X", remplacez le X par la valeur qui est placée avant le signe "{" dans le format suivant /valeur/. Dans ce cas, il s'agit de Time Series FX (Daily) suivi de "/%/" pour déclarer que les dates sont des Variables.
5. Si les Attributs comportent des caractères spéciaux tels qu'un trait de soulignement, des espacesou des mots avec des accents, placez la valeur telle quelle entre crochets [] dans la section other:xPath.

Dans Postman	Devient	Dans Notepad
	=	other:xPath="[1. open]"/> other:xPath="[2. high]"/> other:xPath="[3. low]"/> other:xPath="[4. close]"/>

Dans la documentation du Fournisseur API	Devient	Dans Notepad
	=

6. Une fois le fichier .rsd complété :
   1. Suivez la procédure décrite dans Paramètres pour Custom API pour créer et configurer une nouvelle Connexion (voir Authentifications pour plus de détails).
   2. Suivez la procédure décrite dans Ajouter une Extraction et Configurer le Panneau Extraction pour définir l'extraction.
   3. Suivez la procédure décrite dans Lancer une Extraction pour récupérer les données.

Modifier un Profil API

1. Allez à l'endroit où les Profils API sont stockés.
2. Sélectionnez le fichier du Profil API (extension..apip) dont vous voulez extraire les Tables et changez son extension .apip en .zip.
3. Utilisez votre logiciel d'archivage de fichiers (WinZip, 7-zip ou Winrar ) pour les extraire.
4. Avec un éditeur de texte tel que Notepad, ouvrez le fichier .rsd que vous souhaitez modifier.
5. Reportez-vous aux procédures décrites dans Étapes et Informations Communes et Étapes Spécifiques à un Cas Avancé selon l'arborescence du Profil API que vous souhaitez modifier.

Mettre à jour votre profil API dans Data Sync

Si vous apportez des modifications à votre fichier .rsd et que vous souhaitez que ces modifications soient prises en compte dans Data Sync, vous devez recréer votre Connexion. Pour ce faire :

1. Référez-vous aux procédures décrites dans Supprimer une Extraction et Supprimer une Connexion pour supprimer l'extraction et la connexion liées au Profil API.
2. Suivez la procédure décrite dans Paramètres pour Custom API pour créer et configurer une nouvelle Connexion (voir Authentifications pour plus de détails).
3. Suivez la procédure décrite dans Ajouter une Extraction et Configurer le Panneau Extraction pour définir l'extraction.
4. Suivez la procédure décrite dans Lancer une Extraction pour récupérer les données.