Fournissez des valeurs d’entrée pour votre connecteur d’API

  • Rversion finale: Yokohama
  • Mis à jour 12 janv. 2026
  • 2 minutes de lecture

    • Fournissez des paramètres d’entrée pour effectuer un appel d’API valide, tester la connexion et recevoir un exemple de réponse.

    Avant de commencer

    Pour tous les modèles, vous pouvez sélectionner l’icône d’information ( minuscule i pour plus d’informations) pour en savoir plus sur chaque paramètre. Vous pouvez utiliser les exemples d’API fournis avec chaque modèle. Après avoir défini vos paramètres d’entrée, vous devez tester votre connexion.

    Rôles requis :

    • sn_sec_spc_core.développeur
    • sn_spc_cxf.admin : requis pour le scripting avancé

    Procédure

    1. Renseignez les champs.
      Remarque :
      Si vous modifiez des paramètres d’entrée après avoir testé la connexion, vous devez tester à nouveau la connexion avant de pouvoir continuer vers Mapper la réponse API aux SPC attributs.
      Champ Description Exemple
      Chemin d’accès de la liste d’objets Chemin d’accès à la liste des actifs dans la charge utile de la réponse. Un exemple : $.list
      Chemin d’accès relatif du point de terminaison d’API Il s’agit du chemin d’accès à l’API sans l’URL de l’hôte. Un exemple : /r2
      Paramètres de requêtes d’API Paires clé-valeur qui sont ajoutées à l’URL de l’API pour le filtrage. Les valeurs peuvent être des chaînes, des scripts ou des références à des champs de la table des informations d’identification.

      Un exemple :

      Nom [nom du paramètre de requête]

      Type de valeur [valeurs statiques]

      Valeur [une chaîne]
      Paramètres de pagination Paramètres dynamiques utilisés pour récupérer les pages suivantes de données d’API. Spécifiez le nom du paramètre, son emplacement dans la demande (requête, en-tête ou corps), le chemin d’accès pour extraire sa valeur suivante de la réponse API et une valeur par défaut facultative.

      Exemple de type de pagination Décalage :

      Décalage

      Nom du paramètre [start]

      Emplacement dans la demande d’API [Paramètres de requête]

      Valeur par défaut [0]

      Limite

      Nom du paramètre [nombre]

      Emplacement dans la demande d’API [Paramètres de requête]

      Valeur par défaut [5]
      (Facultatif) Ajouter un paramètre Ajouter des paramètres personnalisés Sélectionnez Ajouter un paramètre pour définir vos propres paramètres.

      Par exemple, vous pouvez déterminer s’il existe des pages supplémentaires de données incluses dans la réponse API.

      Nom de paramètre [hasMore]

      Chemin d’accès dans la réponse API [$.hasMore]

      Emplacement dans la demande d’API [paramètres d’en-tête]

      Valeur par défaut [1]
    2. Lorsque vous êtes satisfait de votre entrée API, sélectionnez Obtenir un exemple de réponse.
      Après quelques instants, un message s’affiche si la connexion a réussi.

      Si vous avez entré vos paramètres manuellement pour cette étape, les données importées à partir du test de connexion qui est restitué dans l’exemple de réponse sont authentiques et vous pouvez les utiliser à l’étape suivante pour vous aider à mapper les paramètres.

    3. Sélectionnez Enregistrer et continuez à enregistrer vos modifications.
      Vous devez enregistrer vos changements pour pouvoir continuer.