Assistance en ligne

4CE – Tester les API

Tutoriel 6 minutes de lecture imprimer

Vous pouvez tester les API de 4CE, dès la génération de votre jeton (token) API.

Attention : Aucun langage de programmation ne sera abordé dans cet article.

Pré-requis :

  • Un scénario en production
  • Une file d’attente
  • Avoir le jeton (token) des API

Le portail

Pour les tests des API connectez sur le portail .

Le portail (voir ci-dessus) vous permet de tester toutes les méthodes misent à votre disposition, et que vous avez déclaré dans votre token.

NB : Seule la langue anglaise est disponible.

Identification

Cliquer sur le bouton vert « Authorise » en début de page.

  1. Saisir votre token (jeton) API
  2. Valider avec le bouton « Authorize »
  1. Permet de se deconnecter pour ressaisir un autre token.
  2. A faire pour fermer la fenêtre, et ainsi utiliser les différentes méthodes.

Attention : Cette authentification permet de pouvoir utiliser toutes les méthodes que vous avez sur cette page si elles sont bien renseignées dans votre token.


Voir un dossier

Nous allons utiliser la méthode Thread, qui va nous permettre d’éditer un dossier via son numéro. Cette méthode doit figurer dans les urls de votre token.

Lors de l’appui sur une ligne de méthode celle-ci se déploie pour obtenir la liste des fonctions disponibles en affichant la méthode HTTP à exécuter pour leur appel.

  1. Méthode HTTP à utiliser
  2. Url de la fonction

En cliquant sur la ligne de la fonction (ci-dessus) vous allez pouvoir consulter la documentation de l’API et la tester grâce au bouton « Try it out ».

La documentation se compose de 3 parties

  1. La partie explication de ce que réalise la fonction.
  2. Les paramètres à renseigner (ceux qui sont obligatoires sont repérés avec une étoile rouge et le mot « required » en rouge (* required).
  3. La partie réponse de la fonction. (Seul le format json est disponible à ce jour).

Réaliser le test

Après avoir cliquer sur le bouton « Try it out » (4), les champs à renseigner apparaissent dans la partie paramètres (2)

Dans cette fonction seul le Token est obligatoire.

  1. Saisissez le numéro du dossier que vous voulez consulter.
  2. Exécutez la commande en cliquant sur le bouton « Execute »

Dans la partie « Responses », vous aurez la commande curl à exécuter, URL et le retour de la fonction (code et détails).

Le token est invalide

Si le token saisie est invalide, ou la méthode appelée n’est pas autorisé, vous aurez une erreur 401.

  1. Commande curl à exécuter pour appeler la fonction.
  2. Url d’appel.
  3. Détail du body et de l’entête de la réponse.

Si le token est valide et le numéro de dossier existe

Dans le cas ou le token est valide, et que le numéro de dossier existe, vous aurez la réponse 200 et le contenu json de retour.

  1. Commande « curl » à exécuter pour appeler la fonction.
  2. Url d’appel.
  3. Retour au format json de la fonction (varie selon la configuration de votre tenant).
  4. Détail de l’entête de la réponse de la fonction.

Si le token est valide et le numéro n’existe pas

Si le token existe mais que le numéro de dossier n’existe pas vous aurez une erreur 401.

  1. Commande curl à exécuter pour appeler la fonction.
  2. Url d’appel.
  3. Détail de l’entête de la réponse de la fonction.

Ces informations vous ont-elles aidé ?

Merci pour votre vote

Laurent

Voir ses articles