Personnaliser votre API

Cette section s'adresse aux utilisateurs qui souhaitent personnaliser un profil API pour répondre à leurs besoins spécifiques.

Vous pouvez créer un profil API à partir de zéro ou 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.

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.

Note

Les tables (fichiers .rsd) sont incluses dans les fichiers de profil API (extension.apip) où les profils API sont compris par le système comme étant des fichiers .zip.

Les fichiers de type .rsd sont des fichiers de schéma utilisés pour :

Saisir des paramètres concernant la gestion des Endpoints dans l'API.
Définir la manière dont les lignes sont affichées dans la table.

Astuce

Nous vous recommandons vivement d'installer le logiciel Postman pour vous aider dans ce processus, car il vous donne une vue claire de la structure du profil API (c'est-à-dire, la manière dont les attributs sont imbriqués). Cliquez ici pour le télécharger gratuitement.

Paramétrer Postman

Une fois Postman installé, ouvrez-le et suivez les étapes ci-dessous afin que Postman puisse récupérer des données de taille illimitée. Ce changement n'est requis que la première fois que vous utilisez Postman.

Dans le coin supérieur droit, cliquez sur l'icône des paramètres (clé) et sélectionnez Settings.
Sous l'onglet General, dans le champ Max Response Size in MB, entrez 0 comme valeur.
Cliquez sur le X pour enregistrer votre changement.

Comprendre la structure des fichiers .rsd

Avant de créer le profil API personnalisé, vous devez 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>

Balise	Description
<api:script>	La première balise <api:script> agit comme la balise <body> dans un fichier HTML. Ses valeurs peuvent être comprises comme celles que l'on trouve dans la balise <head> d'un fichier HTML, c'est-à-dire, que ses métadonnées restent les mêmes. Exemple `<api:script xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:api="http://apiscript.com/ns?v1" >`
<api:info>	Cette balise définit le nom et la description de la table par le biais des paramètres title et desc. Il contient également les paramètres propres aux colonnes appelés Attributs (attr). Les attributs qui peuvent être utilisés diffèrent d'un fournisseur API à l'autre mais trois paramètres restent obligatoires : le nom (name), le type de données (xs:type ) et le chemin (other:xPath). Exemple `<api:info xmlns:other="http://apiscript.com/ns?v1" title="Countries" desc="A List of Countries"> <attr name="name" xs:type="string" readonly="true" other:xPath="name.common"/> <attr name="status" xs:type="string" readonly="true" other:xPath="status"/> <attr name="area" xs:type="integer" readonly="true" other:xPath="area"/> </api:info>` Pour le type de données (xs:type), voici une liste des valeurs les plus utilisées : xs:type="string" : Entrez "string" pour récupérer des données contenant des caractères, des sauts de ligne, des retours de chariot et des caractères de tabulation. xs:type="decimal" : Entrez "decimal" pour récupérer des données contenant des valeurs numériques (ex : 9.12). xs:type="integer" : Entrez "integer" pour récupérer des données contenant des valeurs entières (ex : 9). xs:type="date : Entrez "date" pour récupérer des données contenant la date dans le format AAAA:MM:JJ (AAAA pour l'année, MM pour le mois et JJ pour le jour). xs:type="time" : Entrez "time" pour récupérer des données contenant le temps dans le format hh:mm:ss (hh pour les heures, mm pour les minutes et ss pour les secondes). xs:type="datetime": Entrez "datetime" pour récupérer les données contenant la date et le temps dans le format AAAA-MM-JJThh:mm:ss (AAAA pour l'année, MM pour le mois, JJ pour le jour, T pour le début de la section du Temps, hh pour les heures, mm pour les minutes et ss pour les secondes).
<api:set>	Dans la première balise <api:script>, les paramètres globaux sont définis. <api:set attr="ContentType" value="application/json" /> = indique le type de contenu qui sera renvoyé par l'API. Cette valeur ne change jamais. <api:set attr="RepeatElement" value="/" /> = est utilisé lorsque les données à récupérer ne sont pas accessibles directement à partir du niveau racine, c'est-à-dire qu'il existe un sous-niveau (voir Étapes et informations communes pour plus de détails). Si oui, remplacez le "/" par le nom de l'élément comme Valeur ; ce point est expliqué plus en détail dans Étapes spécifiques à un cas avancé.
<api:script>	La deuxième balise <api:script> fait référence à la méthode HTTP qui sera exécutée par le script. Exemple `<api:script method="GET" >` Une balise <api:set> est nécessaire pour mettre en œuvre la méthode (voir la rangée ci-dessous pour plus de détails).
<api:set>	La balise <api:set> dans la deuxième balise <api:script> est utilisée pour mettre en œuvre la méthode HTTP et définit l'adresse URL (URI) à partir de laquelle les données doivent être récupérées. Pour les méthodes HTTP, vous pouvez utiliser : GET : Correspond à SELECT POST : Correspond à INSERT PUT/PATCH /MERGE : Correspond à UPDATE DELETE GET est la méthode la plus utilisée. Exemple `<!-- 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://restcountries.com/v3.1/all" />`
<api:call>	Cette balise est utilisée pour appeler des opérations par le biais du paramètre op. Elle sera suivie de la balise <api:push> pour afficher (pousser) le résultat dans DataSync. Les opérations autorisées diffèrent d'un fournisseur API à l'autre. Exemple `<api:call op="apisadoExecuteJSONGet"> <api:push/> </api:call> </api:script>`