EN Ikoula wiki - User contributions [en]

REST and WebService architectures

2022-11-06T03:29:13Z

Jquiaios31670:

[[:fr:Architectures REST & WebService]][[fr:Architectures REST & WebService]]
[[:en:REST and WebService architectures]][[en:REST and WebService architectures]]
[[:es:Arquitecturas de resto y WebService]][[es:Arquitecturas de resto y WebService]]
[[:pt:Arquiteturas de descanso e WebService]][[pt:Arquiteturas de descanso e WebService]]
[[:it:Architetture di resto e WebService]][[it:Architetture di resto e WebService]]
[[:nl:RUST en WebService platforms]][[nl:RUST en WebService platforms]]
[[:de:REST- und WebService-Architekturen]][[de:REST- und WebService-Architekturen]]
[[:zh:休息和 web 服务的体系结构]][[zh:休息和 web 服务的体系结构]]
[[:ar:أبنية الراحة وخدمة ويب]][[ar:أبنية الراحة وخدمة ويب]]
[[:ja:休息と web サービスのアーキテクチャ]][[ja:休息と web サービスのアーキテクチャ]]
[[:pl:Architektury REST i WebService]][[pl:Architektury REST i WebService]]
[[:ru:Отдых и WebService архитектуры]][[ru:Отдых и WebService архитектуры]]
[[:ro:ODIHNĂ şi WebService arhitecturi]][[ro:ODIHNĂ şi WebService arhitecturi]]
[[:he:ארכיטקטורות WebService ומנוחה]][[he:ארכיטקטורות WebService ומנוחה]]
[[:en:REST and WebService architectures]][[en:REST and WebService architectures]]
<span data-link_translate_he_title="ארכיטקטורות WebService ומנוחה" data-link_translate_he_url="%D7%90%D7%A8%D7%9B%D7%99%D7%98%D7%A7%D7%98%D7%95%D7%A8%D7%95%D7%AA+WebService+%D7%95%D7%9E%D7%A0%D7%95%D7%97%D7%94">[[:he:ארכיטקטורות WebService ומנוחה]][[he:ארכיטקטורות WebService ומנוחה]]
<span data-link_translate_ru_title="Отдых и WebService архитектуры" data-link_translate_ru_url="%D0%9E%D1%82%D0%B4%D1%8B%D1%85+%D0%B8+WebService+%D0%B0%D1%80%D1%85%D0%B8%D1%82%D0%B5%D0%BA%D1%82%D1%83%D1%80%D1%8B">[[:ru:Отдых и WebService архитектуры]][[ru:Отдых и WebService архитектуры]]
<span data-link_translate_ja_title="休息と web サービスのアーキテクチャ" data-link_translate_ja_url="%E4%BC%91%E6%81%AF%E3%81%A8+web+%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AE%E3%82%A2%E3%83%BC%E3%82%AD%E3%83%86%E3%82%AF%E3%83%81%E3%83%A3">[[:ja:休息と web サービスのアーキテクチャ]][[ja:休息と web サービスのアーキテクチャ]]
[[:ar:أبنية الراحة وخدمة ويب]][[ar:أبنية الراحة وخدمة ويب]]
[[:zh:休息和 web 服务的体系结构]][[zh:休息和 web 服务的体系结构]]
[[:ro:ODIHNĂ şi WebService arhitecturi]][[ro:ODIHNĂ şi WebService arhitecturi]]
[[:pl:Architektury REST i WebService]][[pl:Architektury REST i WebService]]
[[:de:REST- und WebService-Architekturen]][[de:REST- und WebService-Architekturen]]
[[:nl:RUST en WebService platforms]][[nl:RUST en WebService platforms]]
[[:it:Architetture di resto e WebService]][[it:Architetture di resto e WebService]]
[[:pt:Arquiteturas de descanso e WebService]][[pt:Arquiteturas de descanso e WebService]]
[[:es:Arquitecturas de resto y WebService]][[es:Arquitecturas de resto y WebService]]
[[:fr:Architectures REST & WebService]][[fr:Architectures REST & WebService]]

{{#seo:
|title=REST and WebService architectures
|title_mode=append
|keywords=these,are,your,keywords
|description=REST and WebService architectures
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

==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 [[Authentification_et_sécurité| 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 ? <vote />

[[Category:API]]




<comments />
<comments />

The signature generation

2022-11-06T03:28:48Z

Jquiaios31670:

[[:en:The signature generation]][[en:The signature generation]]
[[:he:הדור חתימה]][[he:הדור חתימה]]
[[:ru:Создание подписи]][[ru:Создание подписи]]
[[:ja:署名の生成]][[ja:署名の生成]]
[[:ar:توليد التوقيع]][[ar:توليد التوقيع]]
[[:zh:签名生成]][[zh:签名生成]]
[[:ro:Generația semnături]][[ro:Generația semnături]]
[[:pl:Generowanie podpisu]][[pl:Generowanie podpisu]]
[[:de:Die Signatur-generation]][[de:Die Signatur-generation]]
[[:nl:De handtekening generatie]][[nl:De handtekening generatie]]
[[:it:La generazione della firma]][[it:La generazione della firma]]
[[:pt:A geração de assinatura]][[pt:A geração de assinatura]]
[[:es:La generación de una firma]][[es:La generación de una firma]]
[[:fr:Génération de la signature]][[fr:Génération de la signature]]
 

{{#seo:
|title=The signature generation
|title_mode=append
|keywords=these,are,your,keywords
|description=The signature generation
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

==Introduction == 
During a call to the API, as described in the WIKI of authentication, a signature is required. It is generated '''based on all of the parameters provided during the call '''. 
For technical reasons and for the moment, the authentication parameters must 'always be transmitted via the HTTP GET method

==Example == 


<syntaxhighlight lang="php">
// Définition des paramètres
$data["login"] = "mail@example.com ";
$data["password"] = "DH 4=674j_G "; // Mot de passe non chiffré
// D"autres paramètres peuvent êtres ajoutés en fonction de l"appel à l"API
// $data["autre_parametre"] = "valeur";
// $data["autre_parametre_2"] = "valeur_2";
// $data["..."] = "...";

// Triage des paramètres dans l'ordre croissant
ksort($data);

// Encodage des paramètres
$query = http_build_query($data);

// Encodage des signes plus
$query = str_replace("+", "%20", $query);

// Transformation de la chaîne de caractères en minuscule
$query = strtolower($query);

// Clé publique d'Ikoula (cf. lien ci-dessus)
$public_key="MIIBIjAN...";

// Hashage des paramètres
$hash = hash_hmac("SHA1", $query, $public_key, true);

// Encodage en base64, puis encodage en URL selon RFC 3986
$signature = rawurlencode(base64_encode($hash));

// ==> $signature contient alors la signature finale
</syntaxhighlight>

==Conclusion == 
Once the signature is generated, it is necessary to pass it as a parameter (In addition to all the other parameters ) to the API call. 
Following the previous example, parameters to pass would have therefore been : 
* login = "mail@example.cOM "
* password = "DH 4=674j_G "
* signature = $signature



 
This article seemed you to be useful ? <vote />

[[Category:API]]



<comments />