Paramètres pour Custom API

Le connecteur Custom API agit comme un tout-en-un puisqu'il vous permet de vous connecter à n'importe quelle APIFermé c.-à-d. interface de programmation d'applications : ensemble de fonctions mises à disposition pour interagir et s'intégrer avec une application ou un système..

Puisque chaque API est différente et nécessite donc des paramètres spécifiques, l'interface de ce connecteur est générique.

Pour définir une API, il vous suffit de téléverser le fichier du profil API (extension .apip) et/ou les tables (fichiers .rsd) et de spécifier les propriétés (chaînes de connexion) en les ajoutant manuellement dans la section Autres propriétés de la connexion.

Note

Pour personnaliser un profil API, reportez-vous à Personnaliser votre API ou suivez la procédure décrite ci-dessous pour utiliser un profil API par défaut et ses tables connexes.

Pour configurer la connexion d'un Custom API :

  1. Dans la page des connexions, cliquez sur Nouveau pour créer une nouvelle connexion source.
  2. Dans la liste, sélectionnez Custom API.

  3. Remplissez les champs dans le panneau Nouvelle connexion tel que décrits dans les tableaux ci-dessous.

  4. Modifiez les paramètres avancés (Type de suivi, etc.) selon vos préférences.

  5. Cliquez sur Enregistrer.

Propriétés de la connexion Description
Description Saisissez un nom pour la connexion source (de préférence lié à l'API à laquelle vous souhaitez vous connecter).
Type d'authentification

Sélectionnez la méthode d'authentification utilisée pour l'API:

  • Aucune : Utilisez cette option si vous vous connectez à une API Web publique (c'est-à-dire qu'aucun identifiant n'est requis pour afficher / récupérer les données de l'URL).

  • HTTP Basic:

  • OAuth2: Lorsque vous choisissez cette option, trois paramètres supplémentaires s'ajoutent par défaut ((OAuthClientId, OAuthClientSecret, et CallbackURL).
Verbosité

Le niveau de verbosité qui détermine la quantité de détails inclus dans le fichier journal. Les niveaux de verbosité vont de 1 à 5 ; la valeur par défaut est 3.
Serveur Proxy Sélectionnez cette option si vous souhaitez activer le serveur Proxy.
Profil de l'API

  1. Cliquez sur Téléverser pour naviguer jusqu'à l'emplacement où les profils API sont stockés.

  2. Sélectionnez un profil API.

  3. Cliquez sur Ouvrir.

 

Autres propriétés de la connexion Description
ProfileSettings

Une liste de combinaisons nom-valeur séparées par des points-virgules, requises par la source de données que vous avez choisie. Elle n'est utilisée que pour l'authentification HTTP (Basic).

  • Format : Clé1=Valeur1;clé2=Valeur2

  • Valeurs : User, Password, Domain

  • Chaîne de connexion : ProfileSettings='User=EmailId;Password=key';'Other=Domain=YourDomain'
Other

Dans la plupart des cas, cette propriété est utilisée avec tous les fournisseurs d'API et est similaire à la propriété ProfileSettings. Elle peut être utilisée avec les types d'authentification Aucune, HTTP Basic ou OAuth2.

  • Format : Clé1=Valeur1;clé2=Valeur2

  • Valeurs :

    • DefaultColumnSize définit la longueur par défaut des champs de chaîne lorsque la source de données ne fournit pas la longueur de colonne dans les métadonnées. La valeur par défaut est 2000.

    • ConvertDateTimeToGMT détermine s'il faut convertir les valeurs de la date et de l'heure en GMT, à la place de l'heure locale de la machine.

    • RecordToFile enregistre le transfert de données de la socket sous-jacente vers le fichier spécifié.

  • Chaîne de connexion :

    DefaultColumnSize=numeric value

    ConvertDateTimeToGMT=true

    RecordToFile=file name
CallbackURL

L'URL de rappel OAuth à utiliser lors de l'authentification. Cette valeur doit correspondre à l'URL de rappel que vous indiquez dans les paramètres de votre application.

  • Valeur : adresse URL

  • Chaîne de connexion : CallBack URL=adresse complète de l'URL
OAuthClientId

Le Client ID attribué lorsque vous enregistrez votre application auprès d'un serveur d'autorisation OAuth.

  • Chaîne de connexion : OAuthClientId=clé d'identifiant unique
OAuthClientSecret

Le Client Secret attribué lorsque vous enregistrez votre application auprès d'un serveur d'autorisation OAuth .

  • Chaîne de connexion : OAuthClientSecret=mot de passe
Scope

Définit les actions spécifiques que les applications peuvent être autorisées à effectuer au nom d'un utilisateur. Cette propriété est utilisée avec le type d'authentification OAuth2

  • Valeur : Forms

  • Chaîne de connexion : Forms=Read