Aller au contenu principal

Comprendre la structure du profil API

Un profil API définit le schéma que DataSync utilise pour récupérer et organiser vos données API. Cette page explique la structure des profils API (.rsd files), décrit le but de chaque élément clé et vous guide dans la personnalisation des profils pour répondre à vos besoins spécifiques.

Avant de commencer, assurez-vous d'avoir un logiciel d'archivage de fichiers (comme WinZip, 7-Zip ou WinRAR) installé. Ces outils vous permettent d'extraire et de modifier les tables stockées dans les fichiers de profil API .apip.

Les tables (.rsd files) sont des fichiers de schéma inclus dans les fichiers de profil API (extension .apip, traités comme .zip par le système). Les fichiers .rsd sont utilisés pour définir les paramètres d'entrée pour la gestion des points de terminaison et l'affichage des lignes/colonnes dans DataSync.

astuce

Installez Postman pour vous aider à visualiser la structure de votre API et comprendre l'imbrication des attributs.

Configurer Postman pour de grandes données API​

  1. Ouvrez Postman.
  2. En haut à droite, cliquez sur l'icône des paramètres (clé à molette) et sélectionnez Paramètres.
  3. Sous l'onglet Général, réglez Taille maximale de réponse en Mo sur 0.
  4. Fermez la boîte de dialogue pour enregistrer vos modifications.

Comprendre la structure du fichier .rsd​

Avant de personnaliser ou de créer un profil API, comprenez la structure du fichier .rsd (schéma).

<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>

Composants clés d'un fichier .rsd​

Un fichier .rsd est un fichier XML de schéma qui définit votre profil API personnalisé. Les principaux éléments et leurs objectifs sont décrits ci-dessous.

Structure du script et métadonnées​

Le profil API est encadré par l'élément <api:script>, qui définit les métadonnées du script et les espaces de noms XML :

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

Définir des tables et des colonnes​

L'élément <api:info> définit le nom de la table et la description à l'aide des attributs title et desc. Il spécifie également les colonnes de la table à l'aide d'un ou plusieurs éléments <attr>.

<api:info xmlns:other="http://apiscript.com/ns?v1" title="Pays" desc="Une liste de pays">
    <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>

Valeurs xs:type courantes​

ValeurDescription
stringValeurs de texte (caractères, sauts de ligne, espaces)
decimalNombres décimaux (par exemple, 9.12)
integerNombres entiers (par exemple, 9)
dateDate au format YYYY:MM:DD
timeHeure au format hh:mm:ss
datetimeDate/heure au format YYYY-MM-DDThh:mm:ss

Définir des paramètres globaux​

L'élément <api:set> définit les paramètres applicables à l'ensemble du script. Par exemple, vous définissez le type de contenu afin que le connecteur sache qu'il doit s'attendre à des réponses JSON. Pour identifier comment les enregistrements de données sont regroupés dans la réponse API, définissez l'attribut RepeatElement. Utilisez / pour les enregistrements au niveau racine, ou spécifiez un nom d'élément pour les enregistrements imbriqués. Voir Profils API avancés pour plus de détails sur l'imbrication.

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

Spécifier les méthodes API​

Dans le script principal, ajoutez un élément imbriqué <api:script method="..."> pour indiquer la méthode HTTP que le connecteur doit utiliser, comme GET, POST, PUT, PATCH, MERGE ou DELETE. L'attribut method dans <api:set> doit correspondre, et uri définit le point de terminaison de l'API que DataSync appelle pour extraire les données.

<api:script method="GET">
    <api:set attr="method" value="GET" />
    <api:set attr="uri" value="https://restcountries.com/v3.1/all" />
    ...
</api:script>

Appeler et sortir des données​

L'élément <api:call> spécifie l'opération à exécuter contre l'API, et l'élément <api:push> indique à DataSync de traiter et de récupérer les résultats.

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