Différences entre versions de « Architectures REST & WebService »
Jump to navigation
Jump to search
(Page créée avec « <!-- Début de l'article. Placez votre texte ci-après et n'hésitez pas à personnaliser les chapitres selon votre besoin --> ==Introduction== Avec quelle architecture l... ») |
|||
| (3 versions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
<!-- 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 --> | ||
| − | ==Introduction== | + | |
| + | |||
| + | ==Introduction== <!--T:1--> | ||
Avec quelle architecture l'API est-elle compatible ? | Avec quelle architecture l'API est-elle compatible ? | ||
| − | ==Explication== | + | ==Explication== <!--T:2--> |
L'API Ikoula propose une approche suivant deux architectures: WebService & REST. | L'API Ikoula propose une approche suivant deux architectures: WebService & REST. | ||
| − | ==WebService== | + | ==WebService== <!--T:3--> |
L'architecture WebService s'utilise : | 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 GET (en formatant les paramètres directement dans l'URI) '''obligatoire pour les paramètres d'authentification''' | ||
| Ligne 18 : | Ligne 20 : | ||
: https://api.ikoula.com/index.php?r=wsflex/vminfo&login=mail@example.com&crypted_password=encrypted_password&vm_name=1234hpv56789&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx | : https://api.ikoula.com/index.php?r=wsflex/vminfo&login=mail@example.com&crypted_password=encrypted_password&vm_name=1234hpv56789&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| − | ==REST== | + | ==REST== <!--T:4--> |
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 /> | 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 /> | Voici quelques exemples :<br /> | ||
| + | <!--T:5--> | ||
;Retourne le statut de la VM "vmid" | ;Retourne le statut de la VM "vmid" | ||
: GET /rest/vm/:vmid | : GET /rest/vm/:vmid | ||
| Ligne 29 : | Ligne 32 : | ||
: DELETE /rest/vm/:vmid/snapshot/:snapshotName | : DELETE /rest/vm/:vmid/snapshot/:snapshotName | ||
| + | <!--T:6--> | ||
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 /> | 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 | https://api.ikoula.com/rest/vm/list?login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| + | <!--T:7--> | ||
<!-- Fin de l'article --> | <!-- Fin de l'article --> | ||
<br /><br /> | <br /><br /> | ||
| Ligne 40 : | Ligne 45 : | ||
[[Catégorie:API]] | [[Catégorie:API]] | ||
| + | <!--T:8--> | ||
<!-- Gestion SEO. Indiquez les informations manquantes --> | <!-- Gestion SEO. Indiquez les informations manquantes --> | ||
| + | |||
| + | |||
| + | <comments /> | ||
Version du 16 septembre 2015 à 10:40
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 2 (paramètres présents en GET et en POST)
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.
Voici quelques exemples :
- 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 la sécurité pour plus de détails), voici un exemple d'URL :
https://api.ikoula.com/rest/vm/list?login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
Cet article vous a semblé utile ?
0
Activer l'actualisation automatique des commentaires