Interface de l'API

Le Interface API est une représentation de l'API ExoClick conçue pour détailler les requêtes disponibles, leurs paramètres associés et leurs réponses attendues. Vous pouvez la consulter depuis le panneau d'administration.

Toutes les requêtes API sont répertoriées sous leur groupe associé.

Pour accéder aux requêtes API restreintes, un jeton de session doit être défini. Pour définir un jeton, vous devez disposer d'un compte valide avec le nom d'utilisateur et le mot de passe requis, ou d'un jeton API. Cliquez sur le Se connecter bouton en haut à droite de l'écran et saisissez votre nom d'utilisateur et votre mot de passe, ou fournissez un jeton API. Après avoir cliqué sur le Se connecter bouton, une demande de connexion sera envoyée à l'API afin de récupérer un jeton de session valide. Ce jeton sera ensuite utilisé pour valider toutes les requêtes API que vous souhaitez effectuer dans cette session.

Pour effectuer une requête à l'API, cliquez sur un groupe. Le groupe se développera pour afficher la liste des requêtes disponibles. Cliquez à nouveau sur la requête souhaitée. Un panneau se développera en détaillant les informations de la requête.

• Le Corps de la réponse, le cas échéant, sera affiché en premier à côté de la réponse Type de contenu.
• Le Paramètres de la requête, obligatoires et/ou facultatifs, sont détaillés ensuite, ainsi que la requête Type de contenu, si nécessaire.
• Attendu Messages de réponse sont ensuite répertoriés.
• Pour effectuer la requête, renseignez les paramètres requis. Si le corps de la requête est détaillé, cliquer sur le corps dans le Modèle fenêtre préremplira la fenêtre des paramètres avec le corps.
• Une fois tous les paramètres requis définis, cliquer sur le Essayer bouton exécutera la requête.
• Quatre panneaux apparaîtront sous le bouton :

  • Le premier affiche l'intégralité de la URL de la requête.
  • Le deuxième détaille la Corps de la réponse.
  • Le troisième détaille le Code de réponse.
  • Le quatrième détaille les En-têtes de réponse.