Format de retour

De Ikoula Wiki
Révision datée du 24 septembre 2015 à 09:01 par Ikbot (discussion | contributions)
Jump to navigation Jump to search

en:Return format

Introduction

L'API iKoula propose deux formats de retour pour les réponses : XML & JSON

Explications

Chaque méthode disponible dans l'API renvoie une réponse.
Par défaut, le retour de l'API est en XML.
Il est possible de changer ce format de retour en passant un paramètre supplémentaire format, ayant pour valeur soit json soit xml. Si vous ajoutez ce paramètre, n'oubliez pas de l'ajouter avant la génération de votre signature (voir Attention)

Exemples

Voici quelques exemples d'appels en GET :

XML par défaut
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
XML souhaité
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=xml&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
JSON souhaité
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=json&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Attention

Si vous précisez le format de retour, vous ajoutez un paramètre supplémentaire à l'appel API. Il ne faut donc pas oublier de l'ajouter AVANT de générer votre signature (voir WIKI de Génération de la signature)



Cet article vous a semblé utile ?

0