Interface API

The API Interface is a representation of the ExoClick API designed to detail available requests, their associated parameters and their expected responses. You can view it from the Admin Panel.

Toutes les demandes d'API sont répertoriées dans le groupe qui leur est associé.

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

Pour faire une demande à l'API, cliquez sur un groupe. Le groupe s'agrandit et la liste des demandes disponibles s'affiche. Cliquez à nouveau sur la demande souhaitée. Un panneau s'ouvre et présente les détails de la demande.

• Le corps de la réponse, s'il y en a un, sera affiché en premier à côté du type de contenu de la réponse.

• Les paramètres de la demande, obligatoires et/ou facultatifs, sont détaillés ci-dessous, ainsi que le type de contenu de la demande, le cas échéant.

• Les messages de réponse attendus sont ensuite énumérés.

• Pour effectuer la demande, remplissez les paramètres requis. Si le corps de la demande est détaillé, cliquer sur le corps dans la fenêtre Modèle permet de pré-remplir la fenêtre des paramètres avec le corps.

• Une fois que tous les paramètres requis ont été définis, un clic sur le bouton Essayer permet d'exécuter la demande.

• Quatre panneaux apparaissent sous le bouton :

  • La première affiche l'intégralité de l'URL de la demande.
  • Le second détaille le corps de réponse.
  • Le troisième détaille le Code de réponse.
  • Le quatrième détaille les en-têtes de réponse.