Différences entre versions de « Architectures REST & WebService »

De Ikoula Wiki
Jump to navigation Jump to search
 
(Une version intermédiaire par un autre utilisateur non affichée)
Ligne 15 : Ligne 15 :
 
<!-- Début de l'article. Placez votre texte ci-après et n'hésitez pas à personnaliser les chapitres selon votre besoin -->
 
<!-- Début de l'article. Placez votre texte ci-après et n'hésitez pas à personnaliser les chapitres selon votre besoin -->
  
 
+
#REDIRECT [[Comment_utiliser_l'API_d’Ikoula]]
 
 
==Introduction==
 
Avec quelle architecture l'API est-elle compatible ?
 
 
 
==Explication==
 
L'API Ikoula propose une approche suivant deux architectures : WebService & REST.
 
 
 
==WebService==
 
L'architecture WebService s'utilise :
 
* Soit en GET (en formatant les paramètres directement dans l'URI) '''obligatoire pour les paramètres d'authentification''' ;
 
* Soit en POST (en passant les paramètres en tableau de données) ;
 
* Soit en mixant les deux (paramètres présents en GET et en POST).
 
<br />Voici quelques exemples :
 
;Lister les VM d'un compte
 
: https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
 
;Récupération des informations d'une VM en utilisant son nom
 
: https://api.ikoula.com/index.php?r=wsflex/vminfo&login=mail@example.com&crypted_password=encrypted_password&vm_name=1234hpv56789&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
 
 
 
==REST==
 
L'architecture REST s'utilise en formatant les paramètres dans l'URI et la méthode HTTP adéquate à l'action désirée.<br />
 
Voici quelques exemples :<br />
 
 
 
;Retourne le statut de la VM "vmid"
 
: GET /rest/vm/:vmid
 
;Démarre la VM "vmid"
 
: POST /rest/vm/:vmid/status/start
 
;Supprime le snapshot "snapshotName" de la VM "vmid"
 
: DELETE /rest/vm/:vmid/snapshot/:snapshotName
 
 
 
En passant les paramètres d'authentification (voir WIKI sur l'[[Authentification_et_sécurité|Authentification et la sécurité]] pour plus de détails), voici un exemple d'URL :<br />
 
https://api.ikoula.com/rest/vm/list?login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
 
 
 
<!-- Fin de l'article -->
 
<br /><br />
 
Cet article vous a semblé utile ? <vote />
 
<!-- Placez ici la ou les catégories auxquelles se rapporte votre article. Une ligne par catégorie. Ex:
 
[[Catégorie:Contribuer]]
 
[[Catégorie:Linux]] -->
 
[[Catégorie:API]]
 
[[Catégorie:FLEX]]
 
 
 
<!--T:8-->
 
<!-- Gestion SEO. Indiquez les informations manquantes -->
 
 
 
 
 
 
 
<comments />
 

Version actuelle datée du 22 février 2021 à 17:52