Quelques bases

A faire en premier lieu sur l’interface de développement :

• Renseigner l’API Key
• Renseigner l’API User

Si ces informations manquent, impossible d’obtenir quoique ce soit comme retour d’Équinoxe. Vous obtiendrez un message d’erreur.

A chaque fois que vous souhaitez tester une fonction, il faut envoyer la requête au serveur via le gros bouton central « Valider ».

Nous vous conseillons d’installer dans votre navigateur une extension vous permettant de remplir automatiquement ces deux champs avec les bonnes informations car à chaque rafraîchissement de page ils seront effacés et vous devrez les saisir à nouveau. « Autofill » sous Chrome est une possibilité.

Les autres boutons de cette page :

En plus des deux champs cités plus haut, il y a dans cette page plusieurs autres zones et champs utiles :

• « Méthode » qui n’est modifiables que pour certaines fonctions. Cela différencie simplement la méthode de communication entre votre TMS et Équinoxe. Deux choix seulement sont possibles : POST et GET.
• « API Script » qui est menu déroulant vous permettant de visualiser / choisir la méthode que vous souhaitez utiliser pour communiquer avec Équinoxe. Dès lors où vous avez choisi un script dans ce menu, des modifications interviennent sur l’interface.

L’ensemble des choix de ce menu est détaillé plus en profondeur dans la suite de cette documentation.

• Le bouton contenant un « ? » situé juste à droite du champs API Script vous permet d’accéder à des informations succinctes sur la fonction. Vous pouvez cliquer dessus, une fenêtre modale s’ouvre.
  • Le champs « Query » se modifie le cas échéant et vous indique ce qu’il convient d’envoyer à Équinoxe dans votre URL.
    • Les ‘[‘ ; ‘]’ des variables sont à enlever !
    • Les ‘{‘ ; ‘}’ désignent des variables optionnelles !
  • Le champs « Body » vous indique le cas échéant également les données qu’il convient d’envoyer à Équinoxe pour obtenir une réponse adéquate. Le nom des informations, leur type et leur formatage.

Il s’agit d’un modèle qu’il faut respecter !

• Et enfin dans la partie de droite, la réponse de notre serveur suite à votre requête. Si tout s’est bien passé, notre serveur retourne simplement « OK », sinon il y a un message d’erreur et une information sur l’erreur qui sont retournés. Comme dans le cas d’une mauvaise « API Key » évoqué plus haut.

Au final, L’URL se composera toujours de cette façon :

http://equinoxe.groupe-pole.com/api/API_KEY/USER/Fonction/SousFonction?param1=valeur1&paramX=valeurX

En gras ce qui est obligatoire et ne change pas mais est propre à chaque adhérent. La suite de l’URL est à adapter en fonction du besoin.