Difference between revisions of "REST and WebService architectures"
| Line 1: | Line 1: | ||
| − | |||
| − | This article has been created by an automatic translation software. You can view the article source [[:fr:Architectures REST & WebService|here]].<br /> | + | This article has been created by an automatic translation software. You can view the article source [[:fr:Architectures REST & WebService|here]].<br /><span data-translate="fr"></span> |
| − | |||
| − | < | ||
<!-- 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 --> | ||
| Line 19: | Line 16: | ||
* either get (formatting settings directly in the URI ) '''required for authentication settings ''' | * either get (formatting settings directly in the URI ) '''required for authentication settings ''' | ||
* in POST (passing the parameters in data table ) | * in POST (passing the parameters in data table ) | ||
| − | * either by mixing the 2 ( | + | * either by mixing the 2 (GET and POST settings ) |
<br />Here are some examples : | <br />Here are some examples : | ||
;Lister account VM | ;Lister account VM | ||
| Line 57: | Line 54: | ||
<comments /> | <comments /> | ||
| − | + | <comments /> | |
Revision as of 15:21, 23 September 2015
This article has been created by an automatic translation software. You can view the article source here.
Introduction
With which architecture is the API compatible ?
Explanation
Ikoula API proposes an approach following two architectures : WebService & REST .
WebService
L'architecture WebService s'utilise :
- either get (formatting settings directly in the URI ) required for authentication settings
- in POST (passing the parameters in data table )
- either by mixing the 2 (GET and POST settings )
Here are some examples :
- Lister account VM
- https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
- Retrieving information from a VM by using its name
- 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.
Here are some examples :
- Returns the status of the VM "VMID "
- GET /rest/vm/:vmid
- Starts the VM "VMID "
- POST /rest/vm/:vmid/status /Start
- Removes the snapshot "snapshot Name " the VM "VMID "
- DELETE /rest/vm/:vmid/snapshot /:snapshot Name
Passing the authentication settings (see WIKI on the Authentication and security For more details ), here is an example URL :
https://api.ikoula.com/rest/vm/list?login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
This article seemed you to be useful ?
<comments />
Enable comment auto-refresher