Connecteur source Custom API

Le connecteur source Custom API dans DataSync vous permet de vous connecter à n'importe quelle interface de programmation (API) pour l'extraction et l'intégration de données. Ce connecteur prend en charge les API en téléchargeant un fichier de profil API (.apip) et/ou des définitions de table (.rsd files), puis en spécifiant les propriétés de connexion selon les besoins.

Pour définir une API, il vous suffit de télécharger le fichier de profil API (avec l'extension .apip) et/ou les Tables (.rsd files) et de spécifier les propriétés (chaînes de connexion) en les ajoutant manuellement via la section Propriétés de connexion supplémentaires.

Après avoir créé toutes les connexions sources requises, configurez votre connexion de destination pour finaliser la configuration.

remarque

Vous devez créer des profils API (.apip ou .rsd files) avant de pouvoir configurer une connexion source API personnalisée. Pour plus de détails, consultez Comprendre la structure du profil API et suivez les étapes dans Créer un profil API personnalisé.

Créer une connexion source dans DataSync

1. Connectez-vous à DataSync.
2. Depuis l'écran d'accueil, sélectionnez Connexions.
3. À côté de Connexions Sources, cliquez sur Nouvelle.
4. Sélectionnez API Personnalisée.
5. Dans le panneau Propriétés de la connexion, entrez les propriétés de connexion.
6. (Optionnel) Dans le panneau Autres propriétés de la connexion, sélectionnez Ajouter une propriété et entrez les paramètres pour chaque propriété.
7. Dans le panneau Paramètres avancés, configurez les paramètres, y compris le Type de suivi et d'autres valeurs selon vos besoins.
8. Cliquez sur Enregistrer.

Paramètres

Propriétés de la connexion

Paramètre	Description
Description	Nom unique pour la connexion API. Exemple : API Personnalisée
Type d'authentification	Méthode d'authentification utilisée par l'API : Aucune – API Web publique sans identifiants. HTTP (Basique) – Authentification HTTP Basique avec nom d'utilisateur et mot de passe. OAuth2 – Authentification OAuth2. Ajoute OAuthClientId, OAuthClientSecret et CallbackURL propriétés.
Verbosité	1 – Journaliser les requêtes, nombres de lignes, début/fin d'exécution, erreurs. 2 – Inclut le niveau 1 plus les requêtes mise en cache, en-têtes HTTP. 3 – Inclut le niveau 2 plus les corps de requête/réponse. 4 – Inclut le niveau 3 plus la communication au niveau du transport. 5 – Inclut le niveau 4 plus toutes les commandes d'interface.
Profil API	Emplacement de téléchargement pour le profil API ou les définitions de table.

Autres propriétés de la connexion

Propriétés de chaîne de connexion supplémentaires non spécifiées dans le panneau Propriétés de la connexion. Pour chaque propriété ajoutée, vous pouvez choisir Visible ou Crypé. Sélectionner Crypé cache la valeur de l'interface et la stocke de manière chiffrée dans le backend, par exemple lors de la définition de mots de passe. Les propriétés typiques dépendent du type d'authentification utilisée.

Propriété	Valeur
Other	Paire nom-valeur pour des options supplémentaires du fournisseur API. Exemples courants : DefaultColumnSize=number – Définit la longueur par défaut des champs string lorsque non fournie par les métadonnées. Par défaut : 2000. ConvertDateTimeToGMT=true – Convertit les valeurs de date-heure en GMT au lieu de l'heure locale. RecordToFile=file name – Enregistre les transferts de données de socket dans le fichier spécifié.
ProfileSettings	Liste séparée par des points-virgules des paramètres requis par la source de données. Utilisé avec l'authentification HTTP (de base). Exemple : ProfileSettings='User=EmailId;Password=key';'Other=Domain=YourDomain'.
CallbackURL	URL de redirection pour l'authentification OAuth2. Celle-ci doit correspondre à l'URL de rappel spécifiée dans les paramètres de l'application. Exemple : https://.../OAuthCallback/CallbackUrl/...
OAuthClientId	Identifiant attribué par le serveur d'autorisation OAuth2. Exemple : OAuthClientId=Clé d'identification unique.
OAuthClientSecret	Valeur secrète attribuée par le serveur d'autorisation OAuth2. Exemple : OAuthClientSecret=password
Scope	Action ou portée de permission pour l'application avec authentification OAuth2. Exemple : Forms=Read

Paramètres avancés

Les paramètres avancés contrôlent comment le connecteur API personnalisé suit les changements, gère la configuration régionale et horaire, et traite les lots de données lors de l'extraction. Ces options permettent un ajustement fin pour la performance et la précision et doivent être configurées en fonction de votre environnement système et de vos besoins opérationnels.

Paramètre	Description
Type de Suivi	Méthode de suivi des changements : Aucun ou Date.
Région	Paramètre de région pour le connecteur, si nécessaire dans votre configuration.
Fuseau horaire	Fuseau horaire correspondant au serveur d'application API Personnalisée. Cela doit être identique au fuseau horaire du profil dans l'API Personnalisée pour éviter des incohérences de données.
Décalage temporel	Décalage de rafraîchissement en secondes pour compenser les problèmes de synchronisation dans la sélection des enregistrements. La valeur minimale est 0; la maximum est 3600 secondes.
Taille de Lot	Quantité d'enregistrements traités dans chaque lot lors de l'extraction. Des tailles de lot plus grandes augmentent l'utilisation de la mémoire mais peuvent améliorer les performances jusqu'à un certain point. La valeur par défaut est 2000 et le maximum ne doit pas dépasser 10000 enregistrements. Ajustez selon la vitesse de votre réseau et les performances de votre disque ; dans la plupart des cas, la valeur par défaut (2000) fonctionne le mieux.