REST and WebService architectures

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽

fr:Architectures REST & WebService en:REST and WebService architectures es:Arquitecturas de resto y WebService pt:Arquiteturas de descanso e WebService it:Architetture di resto e WebService nl:RUST en WebService platforms de:REST- und WebService-Architekturen zh:休息和 web 服务的体系结构 ar:أبنية الراحة وخدمة ويب ja:休息と web サービスのアーキテクチャ pl:Architektury REST i WebService ru:Отдых и WebService архитектуры ro:ODIHNĂ şi WebService arhitecturi he:ארכיטקטורות WebService ומנוחה en:REST and WebService architectures he:ארכיטקטורות WebService ומנוחה ru:Отдых и WebService архитектуры ja:休息と web サービスのアーキテクチャ ar:أبنية الراحة وخدمة ويب zh:休息和 web 服务的体系结构 ro:ODIHNĂ şi WebService arhitecturi pl:Architektury REST i WebService 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 fr:Architectures REST & WebService


Introduction

With which WebService architecture is the API compatible ?

Explanation

Ikoula API proposes an approach following two architectures : WebService & REST .

WebService

The WebService architecture can be used :

  • either get (formatting settings directly in the URI ) required for authentication settings
  • in POST (passing the parameters in data table )
  • or 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

The REST architecture is used by formatting parameters in the URI and HTTP method suitable to the desired action.
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 ?

0




You are not allowed to post comments.

<comments />