Documentation API

S’abonner

mceclip1.png

 

Pour accéder à la documentation API : https://api.fts-crm360.com/doc/

Cette plateforme permet de lister l'ensemble des méthodes disponibles, ainsi que les formats d'envois et de réponses.

mceclip2.png

 

Dans la définition des objets et paramètres, les données obligatoires sont indiquées par un *.

 

Se connecter à sa plateforme

il faut renseigner sa clef API pour se connecter à sa plateforme (Cf. Votre API Key).

 

Tester une méthode

Les méthodes sont répertoriées dans le menu de gauche, et rangées par domaine fonctionnel.

 

mceclip3.png

 

Pour exécuter une méthode, il faut renseigner l'objet dans l'espace "REQUEST BODY" dans la partie example. Il est possible de se base sur un exemple auto-généré en cliquant sur "FILL EXAMPLE" dans les boutons d'action.

Une fois l'objet renseigné, le bouton d'action "TRY" permet d'envoyer la requête vers la plateforme, et génère le code retour associé.

 

Attention : ces requêtes interagissent avec votre plateforme, assurez vous de renseigner une plateforme ou une zone de test.

 

Identifier le code de retour

  • 200 : OK
  • 400 : erreur technique, requête invalide
  • 500 : erreur fonctionnelle, souci de données.

Pour les erreurs techniques ou fonctionnelles, le bloc retour donne de plus amples informations sur les causes.

 

 

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0
Vous avez d’autres questions ? Envoyer une demande