Différences entre versions de « Architectures REST & WebService »
| Ligne 16 : | Ligne 16 : | ||
| − | ==Introduction== | + | ==Introduction== |
Avec quelle architecture l'API est-elle compatible ? | Avec quelle architecture l'API est-elle compatible ? | ||
| − | ==Explication== | + | ==Explication== |
L'API Ikoula propose une approche suivant deux architectures : WebService & REST. | L'API Ikoula propose une approche suivant deux architectures : WebService & REST. | ||
| − | ==WebService== | + | ==WebService== |
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 33 : | Ligne 33 : | ||
: 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== |
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 /> | ||
| − | |||
;Retourne le statut de la VM "vmid" | ;Retourne le statut de la VM "vmid" | ||
: GET /rest/vm/:vmid | : GET /rest/vm/:vmid | ||
| Ligne 45 : | Ligne 44 : | ||
: DELETE /rest/vm/:vmid/snapshot/:snapshotName | : 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 /> | 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 | ||
| − | |||
<!-- Fin de l'article --> | <!-- Fin de l'article --> | ||
<br /><br /> | <br /><br /> | ||
Version du 19 octobre 2016 à 11:41
he:ארכיטקטורות WebService ומנוחה ro:ODIHNĂ şi WebService arhitecturi ru:Отдых и WebService архитектуры pl:Architektury REST i WebService ja:休息と web サービスのアーキテクチャ ar:أبنية الراحة وخدمة ويب zh:休息和 web 服务的体系结构 de:REST- und WebService-Architekturen nl:RUST en WebService platforms it:Architetture di resto e WebService pt:Arquiteturas de descanso e WebService es:Arquitecturas de resto y WebService en:REST and WebService architectures
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).
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 ?
Activer l'actualisation automatique des commentaires