Connecteur source Custom API

Le connecteur source Custom API permet à DataSync de se connecter à n'importe quelle API REST pour extraire et charger des données dans un entrepôt de données. Avant de configurer la connexion, un fichier de profil API (.apip), des fichiers de définition de table (.rsd), ou les deux, doivent être préparés, puis les propriétés de connexion requises doivent être complétées.

DataSync propose trois types d'authentification pour les connexions Custom API : None pour les API publiques, HTTP Basic pour une authentification par nom d'utilisateur et mot de passe, et OAuth 2.0. OAuth 2.0 propose lui-même deux méthodes : code d'autorisation pour les configurations où un utilisateur se connecte via un navigateur, et identifiants client pour les connexions système à système ne nécessitant aucune connexion utilisateur.

remarque

Les fichiers de profil API (.apip ou .rsd) doivent être créés avant de configurer une connexion source Custom API. Voir Comprendre la structure d'un profil API et Créer un profil API personnalisé pour commencer.

Une fois la connexion source créée, configurez la connexion de destination pour finaliser l'installation.

Créer la connexion source dans DataSync

1. Connectez-vous à DataSync.
2. Depuis l'écran d'accueil, sélectionnez Connexions.
3. À côté de Connexions de la source, cliquez sur Nouveau.
4. Sélectionnez Custom API.
5. Complétez toutes les propriétés de connexion requises.
6. (Facultatif) Dans le panneau Autres propriétés de la connexion, cliquez sur Ajouter une propriété et définissez les paramètres supplémentaires nécessaires.
7. Configurez les paramètres avancés selon votre environnement, notamment le Type de suivi.
8. Cliquez sur Enregistrer.

Propriétés de la connexion

Propriété	Description
Description	Nom unique attribué à la connexion. Exemple : API Personnalisée.
Type d'authentification	Méthode d'authentification utilisée par l'API. None pour les API publiques ne nécessitant aucune authentification. HTTP (Basic) pour une authentification par nom d'utilisateur et mot de passe. Les identifiants sont saisis via ProfileSettings. OAuth2 pour l'authentification OAuth 2.0. Prend en charge la méthode du code d'autorisation lorsqu'une URL de rappel est requise, ou la méthode des identifiants client pour les connexions système à système sans rappel.
Verbosité	Contrôle le niveau de détail écrit dans le journal. Chaque niveau inclut tout ce qui précède plus des informations supplémentaires. 1 enregistre les requêtes, les nombres de lignes, les heures de début et de fin d'exécution ainsi que les erreurs. 2 ajoute les requêtes de cache et les en-têtes HTTP. 3 ajoute les corps de requête et de réponse. 4 ajoute la communication au niveau du transport. 5 ajoute toutes les commandes d'interface.
Profil API	Emplacement de téléversement du profil API ou des fichiers de définition de table. Pour les configurations avec identifiants client, voir l'exemple OAuth2 identifiants client.

Propriétés de connexion supplémentaires pour HTTP Basic

Propriété	Valeur à saisir
ProfileSettings	Paramètres requis par la source de données, saisis sous forme de paires nom-valeur séparées par des virgules. Exemple : ProfileSettings='User=EmailId;Password=key';'Other=Domain=YourDomain'.
Other	Options supplémentaires du fournisseur sous forme de paires nom-valeur. Valeurs courantes : DefaultColumnSize=number définit la longueur de chaîne par défaut lorsque les métadonnées de l'API n'en spécifient aucune. Valeur par défaut : 2000. ConvertDateTimeToGMT=true convertit les valeurs de date et d'heure en GMT au lieu de l'heure locale. RecordToFile=filename enregistre les transferts de données du socket dans le fichier spécifié.

Exemple de configuration avec HTTP Basic

Connexion source Custom API avec authentification HTTP Basic entièrement configurée dans DataSync, avec toutes les propriétés et tous les paramètres complétés.

Propriétés de connexion supplémentaires pour OAuth2 (code d'autorisation)

Cette méthode s'utilise lorsqu'un utilisateur s'authentifie via un navigateur et que le serveur d'autorisation redirige vers une URL de rappel.

Propriété	Valeur à saisir
CallbackURL	URL de redirection pour OAuth2. Doit correspondre à l'URL de rappel configurée dans les paramètres de l'application OAuth. Exemple : https://datasync.mycompany.com/OAuthCallback/CallbackUrl.
OAuthClientId	Identifiant client attribué par le serveur d'autorisation OAuth2. Exemple : abc123clientid.
OAuthClientSecret	Secret attribué par le serveur d'autorisation OAuth2. Définir le type sur Crypté. Exemple : xK8mNpL7vRtYw2cDjHs9bEuFgAiZo3qB.
Scope	Portée des permissions pour l'application. Exemple : Forms=Read.
Other	Options supplémentaires du fournisseur sous forme de paires nom-valeur. Valeurs courantes : DefaultColumnSize=number définit la longueur de chaîne par défaut lorsque les métadonnées de l'API n'en spécifient aucune. Valeur par défaut : 2000. ConvertDateTimeToGMT=true convertit les valeurs de date et d'heure en GMT au lieu de l'heure locale. RecordToFile=filename enregistre les transferts de données du socket dans le fichier spécifié.

Exemple de configuration avec OAuth2 (code d'autorisation)

Connexion source Custom API avec code d'autorisation OAuth2 entièrement configurée dans DataSync, avec toutes les propriétés et tous les paramètres complétés.

Propriétés de connexion supplémentaires pour OAuth2 (identifiants client)

Cette méthode s'utilise pour les connexions système à système ne nécessitant aucune connexion utilisateur ni URL de rappel.

Propriété	Valeur à saisir
AuthScheme	Saisir OAuth.
OAuthClientId	Identifiant client attribué par le serveur d'autorisation OAuth2.
OAuthClientSecret	Secret attribué par le serveur d'autorisation OAuth2. Définir le type sur Crypté.
Scope	Portée des permissions requise par le fournisseur. Exemple : employees.readonly.
InitiateOAuth	Saisir GETANDREFRESH.
Other	Saisir OAuthIncludedCallbackURL=False.

Exemple de configuration avec OAuth2 (identifiants client)

Connexion source Custom API avec identifiants client OAuth2 entièrement configurée dans DataSync, avec toutes les propriétés et tous les paramètres complétés.

Paramètres avancés

Ces paramètres déterminent la façon dont le connecteur suit les modifications de données, gère l'heure et la région, et traite les enregistrements pendant l'extraction. Ajustez-les selon votre environnement Custom API afin que les résultats restent exacts et cohérents.

Paramètre	Description
Type de suivi	Méthode de suivi des modifications de données : Aucun ou Date.
Region	Paramètre régional du connecteur, si la configuration l'exige.
Fuseau horaire	Fuseau horaire correspondant à l'environnement Custom API.
Décalage de temps	Décalage d'actualisation en secondes pour compenser les écarts de synchronisation lors de la sélection des enregistrements. Minimum 0, maximum 3600.
Taille du lot	Nombre d'enregistrements traités par lot lors de l'extraction. Des lots plus grands peuvent améliorer les performances mais consomment davantage de mémoire. La valeur par défaut est 2000, le maximum est 10000. À ajuster selon la vitesse du réseau et les performances du disque. La valeur par défaut convient dans la plupart des cas.