Aller au contenu principal

Connecteur source Custom API

Le connecteur source Custom API permet de se connecter à n'importe quelle API REST pour extraire et intégrer des données. Pour configurer la connexion, importez un fichier de profil API (.apip), des définitions de tables (fichiers .rsd), ou les deux, puis renseignez les propriétés de connexion requises.

Ensuite, configurez votre connexion de destination pour définir où les données seront chargées.

remarque

Créez vos fichiers de profil API (.apip ou .rsd files) avant de configurer une connexion source Custom API. Pour plus d'informations, consultez Comprendre la structure du profil API et 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 de la source, cliquez sur Nouveau.
  4. Sélectionnez Odoo.
  5. Renseignez les propriétés de connexion.
  6. (Facultatif) Dans le panneau Autres propriétés de la connexion, sélectionnez Ajouter une propriété et renseignez les paramètres.
  7. Dans le panneau Paramètres avancés, configurez les paramètres, notamment le Type de suivi et les autres valeurs nécessaires à votre installation.
  8. Cliquez sur Enregistrer.

Paramètres

Propriétés de la connexion

ParamètreDescription
DescriptionNom unique pour cette connexion. Par exemple : API Personnalisée
Type d'authentificationMéthode d'authentification utilisée par votre API. Choisissez parmi les options suivantes :

  • 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éNiveau de détail des journaux. Chaque niveau inclut les informations du niveau précédent.
  • 1 – requêtes, nombre de lignes, heures de début et de fin, erreurs.
  • 2 – ajoute les requêtes en cache et les en-têtes HTTP.
  • 3 – ajoute le contenu des requêtes et des réponses.
  • 4 – ajoute les communications au niveau transport.
  • 5 – ajoute toutes les commandes d'interface.
Profil APIEmplacement de téléchargement pour le profil API ou les définitions de table.

Autres propriétés de la connexion

Ce panneau permet d'ajouter des propriétés de connexion qui ne sont pas disponibles dans le panneau principal. Pour chaque propriété, choisissez Visible ou Crypé. Utilisez Crypé pour les mots de passe et autres valeurs sensibles.

PropriétéValeur
OtherPaire 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é.
ProfileSettingsListe 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'.
CallbackURLURL 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/...
OAuthClientIdIdentifiant attribué par le serveur d'autorisation OAuth2.
Exemple : OAuthClientId=Clé d'identification unique.
OAuthClientSecretValeur secrète attribuée par le serveur d'autorisation OAuth2.
Exemple : OAuthClientSecret=password
ScopeAction ou portée de permission pour l'application avec authentification OAuth2.
Exemple : Forms=Read

Paramètres avancés

Ces paramètres contrôlent le suivi des modifications, la gestion du temps et le traitement des données lors de l'extraction. Adaptez-les à votre installation pour obtenir des résultats fiables.

ParamètreDescription
Type de suiviMéthode de détection des modifications. Sélectionnez Aucun ou Date.
RégionRégion du connecteur, si votre installation le demande.
Fuseau horaireFuseau horaire du serveur Odoo. Doit correspondre au fuseau horaire configuré dans DataSync. Un écart peut provoquer des erreurs de synchronisation ou des données incorrectes.
Décalage horaireDécalage en secondes pour corriger les écarts de timing. Valeur minimale : 0. Valeur maximale : 3600 secondes.
Taille de lotNombre d'enregistrements traités par lot. Une valeur plus élevée peut améliorer les performances, mais utilise plus de mémoire. Par défaut : 2000. Maximum : 10000. Ajustez selon votre connexion réseau et les performances de votre disque.