Difference between revisions of "How to use the Cloud Ikoula private API"
(Created page with "This article has been created by an automatic translation software. You can view the article source here.<br /> <!--...") |
|||
| (23 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <span data-link_translate_en_title="How to use the Cloud Ikoula private API" data-link_translate_en_url="How to use the Cloud Ikoula private API"></span>[[:en:How to use the Cloud Ikoula private API]][[en:How to use the Cloud Ikoula private API]] | |
| + | <span data-link_translate_he_title="כיצד להשתמש ב- API פרטיים של ענן Ikoula" data-link_translate_he_url="%D7%9B%D7%99%D7%A6%D7%93+%D7%9C%D7%94%D7%A9%D7%AA%D7%9E%D7%A9+%D7%91-+API+%D7%A4%D7%A8%D7%98%D7%99%D7%99%D7%9D+%D7%A9%D7%9C+%D7%A2%D7%A0%D7%9F+Ikoula"></span>[[:he:כיצד להשתמש ב- API פרטיים של ענן Ikoula]][[he:כיצד להשתמש ב- API פרטיים של ענן Ikoula]] | ||
| + | <span data-link_translate_ru_title="Как использовать API частных облачных Ikoula" data-link_translate_ru_url="%D0%9A%D0%B0%D0%BA+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D1%8C+API+%D1%87%D0%B0%D1%81%D1%82%D0%BD%D1%8B%D1%85+%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D1%8B%D1%85+Ikoula"></span>[[:ru:Как использовать API частных облачных Ikoula]][[ru:Как использовать API частных облачных Ikoula]] | ||
| + | <span data-link_translate_ja_title="クラウド Ikoula 専用 API を使用する方法" data-link_translate_ja_url="%E3%82%AF%E3%83%A9%E3%82%A6%E3%83%89+Ikoula+%E5%B0%82%E7%94%A8+API+%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95"></span>[[:ja:クラウド Ikoula 専用 API を使用する方法]][[ja:クラウド Ikoula 専用 API を使用する方法]] | ||
| + | <span data-link_translate_ar_title="كيفية استخدام API الخاصة "إيكولا سحابة"" data-link_translate_ar_url="%D9%83%D9%8A%D9%81%D9%8A%D8%A9+%D8%A7%D8%B3%D8%AA%D8%AE%D8%AF%D8%A7%D9%85+API+%D8%A7%D9%84%D8%AE%D8%A7%D8%B5%D8%A9+%22%D8%A5%D9%8A%D9%83%D9%88%D9%84%D8%A7+%D8%B3%D8%AD%D8%A7%D8%A8%D8%A9%22"></span>[[:ar:كيفية استخدام API الخاصة "إيكولا سحابة"]][[ar:كيفية استخدام API الخاصة "إيكولا سحابة"]] | ||
| + | <span data-link_translate_zh_title="如何使用云 Ikoula 私有 API" data-link_translate_zh_url="%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8%E4%BA%91+Ikoula+%E7%A7%81%E6%9C%89+API"></span>[[:zh:如何使用云 Ikoula 私有 API]][[zh:如何使用云 Ikoula 私有 API]] | ||
| + | <span data-link_translate_ro_title="Cum să utilizaţi nor Ikoula privat API" data-link_translate_ro_url="Cum+s%C4%83+utiliza%C5%A3i+nor+Ikoula+privat+API"></span>[[:ro:Cum să utilizaţi nor Ikoula privat API]][[ro:Cum să utilizaţi nor Ikoula privat API]] | ||
| + | <span data-link_translate_pl_title="Jak korzystać z interfejsu API prywatne Cloud Ikoula" data-link_translate_pl_url="Jak+korzysta%C4%87+z+interfejsu+API+prywatne+Cloud+Ikoula"></span>[[:pl:Jak korzystać z interfejsu API prywatne Cloud Ikoula]][[pl:Jak korzystać z interfejsu API prywatne Cloud Ikoula]] | ||
| + | <span data-link_translate_de_title="Wie Sie die private Cloud Ikoula-API verwenden" data-link_translate_de_url="Wie+Sie+die+private+Cloud+Ikoula-API+verwenden"></span>[[:de:Wie Sie die private Cloud Ikoula-API verwenden]][[de:Wie Sie die private Cloud Ikoula-API verwenden]] | ||
| + | <span data-link_translate_nl_title="Hoe de wolk Ikoula privé API kunt gebruiken" data-link_translate_nl_url="Hoe+de+wolk+Ikoula+priv%C3%A9+API+kunt+gebruiken"></span>[[:nl:Hoe de wolk Ikoula privé API kunt gebruiken]][[nl:Hoe de wolk Ikoula privé API kunt gebruiken]] | ||
| + | <span data-link_translate_it_title="Come utilizzare l'API privata Cloud Ikoula" data-link_translate_it_url="Come+utilizzare+l%27API+privata+Cloud+Ikoula"></span>[[:it:Come utilizzare l'API privata Cloud Ikoula]][[it:Come utilizzare l'API privata Cloud Ikoula]] | ||
| + | <span data-link_translate_pt_title="Como usar a API de Ikoula de nuvem privada" data-link_translate_pt_url="Como+usar+a+API+de+Ikoula+de+nuvem+privada"></span>[[:pt:Como usar a API de Ikoula de nuvem privada]][[pt:Como usar a API de Ikoula de nuvem privada]] | ||
| + | <span data-link_translate_es_title="Cómo utilizar la API privada de nube Ikoula" data-link_translate_es_url="C%C3%B3mo+utilizar+la+API+privada+de+nube+Ikoula"></span>[[:es:Cómo utilizar la API privada de nube Ikoula]][[es:Cómo utilizar la API privada de nube Ikoula]] | ||
| + | <span data-link_translate_fr_title="Comment utiliser l'API Cloud Privé dâIkoula" data-link_translate_fr_url="Comment_utiliser_l%27API_Cloud_Priv%C3%A9_d%E2%80%99Ikoula"></span>[[:fr:Comment utiliser l'API Cloud Privé d’Ikoula]][[fr:Comment utiliser l'API Cloud Privé d’Ikoula]] | ||
| + | {{#seo: | ||
| + | |title=How to use the Cloud Ikoula private API | ||
| + | |title_mode=append | ||
| + | |keywords=these,are,your,keywords | ||
| + | |description=How to use the Cloud Ikoula private API | ||
| + | |image=Uploaded_file.png | ||
| + | |image_alt=Wiki Logo | ||
| + | }} | ||
<!--T:1--> | <!--T:1--> | ||
| − | When you register for the service b. <span class="notranslate">Cloud</span> Private Ikoula, you received an email with an API key and a secret key. | + | When you register for the service b. <span class="notranslate">Cloud</span> Private Ikoula, you received an email with an '''API''' key and a secret key. |
This information will allow you to connect to the API b. <span class="notranslate">Cloud</span> Private Ikoula. | This information will allow you to connect to the API b. <span class="notranslate">Cloud</span> Private Ikoula. | ||
| Line 12: | Line 33: | ||
<!--T:3--> | <!--T:3--> | ||
| − | The domain administrator and user API specifications are respectively : | + | The domain administrator and user ''API'' specifications are respectively : |
<!--T:4--> | <!--T:4--> | ||
| Line 24: | Line 45: | ||
* Your API key | * Your API key | ||
* Your secret key | * Your secret key | ||
| − | * Send queries on "https://cloudstack.ikoula.com/client/api" with a method of | + | * Send queries on "https://cloudstack.ikoula.com/client/api" with a method of HTTP |
* Treat the return XML or JSON (choice ) | * Treat the return XML or JSON (choice ) | ||
| Line 31: | Line 52: | ||
<!--T:8--> | <!--T:8--> | ||
| + | <syntaxhighlight lang="php" line> | ||
# https://cloudstack.ikoula.com/client/api/ | # https://cloudstack.ikoula.com/client/api/ | ||
# ?command =deployVirtualMachine | # ?command =deployVirtualMachine | ||
| Line 38: | Line 60: | ||
# &zoneId =4 | # &zoneId =4 | ||
# &apiKey =miVr 6X7u6bN_EJTVwZ 0nUkkJbPmY 3y2bciKwFQ | # &apiKey =miVr 6X7u6bN_EJTVwZ 0nUkkJbPmY 3y2bciKwFQ | ||
| − | # &signature =LXX | + | # &signature =LXX 1DM 40AjcXU %2FcaiK 8RAP 0O1hU %3D |
| − | + | </syntaxhighlight> | |
<!--T:9--> | <!--T:9--> | ||
| − | The line 1 corresponds to the point of entry (the link to the API b. <span class="notranslate">Cloud</span> | + | The line 1 corresponds to the point of entry (the link to the API b. <span class="notranslate">Cloud</span> Ikoula private ) |
The line 2 correspond a la command e a envoyer, ici on veut crée une nouvelle VM | The line 2 correspond a la command e a envoyer, ici on veut crée une nouvelle VM | ||
The line 3-6 correspondent aux différents paramètres de la command e. | The line 3-6 correspondent aux différents paramètres de la command e. | ||
| Line 55: | Line 77: | ||
<!--T:12--> | <!--T:12--> | ||
| − | To sort alphabetically sent fields. Attention to the settings one after the other separated by a & ( | + | To sort alphabetically sent fields. Attention to the settings one after the other separated by a & (Ampersand )and the string to lowercase. |
<!--T:13--> | <!--T:13--> | ||
| Line 82: | Line 104: | ||
[[Category:API_cloudstack]] | [[Category:API_cloudstack]] | ||
[[Category:cloudstack]] | [[Category:cloudstack]] | ||
| − | + | <comments /> | |
| − | |||
Latest revision as of 17:07, 23 September 2021
en:How to use the Cloud Ikoula private API he:כיצד להשתמש ב- API פרטיים של ענן Ikoula ru:Как использовать API частных облачных Ikoula ja:クラウド Ikoula 専用 API を使用する方法 ar:كيفية استخدام API الخاصة "إيكولا سحابة" zh:如何使用云 Ikoula 私有 API ro:Cum să utilizaţi nor Ikoula privat API pl:Jak korzystać z interfejsu API prywatne Cloud Ikoula de:Wie Sie die private Cloud Ikoula-API verwenden nl:Hoe de wolk Ikoula privé API kunt gebruiken it:Come utilizzare l'API privata Cloud Ikoula pt:Como usar a API de Ikoula de nuvem privada es:Cómo utilizar la API privada de nube Ikoula fr:Comment utiliser l'API Cloud Privé d’Ikoula
When you register for the service b. Cloud Private Ikoula, you received an email with an API key and a secret key.
This information will allow you to connect to the API b. Cloud Private Ikoula.
URL API : https://cloudstack.ikoula.com/client/api
The domain administrator and user API specifications are respectively :
Admin : http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_Domain_Admin.html User : http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_User.html
The use of the API, to :
- Your API key
- Your secret key
- Send queries on "https://cloudstack.ikoula.com/client/api" with a method of HTTP
- Treat the return XML or JSON (choice )
Example of a query has the API using the GET method :
1# https://cloudstack.ikoula.com/client/api/
2# ?command =deployVirtualMachine
3# &serviceOfferingId =1
4# &diskOfferingId =1
5# &templateId =2
6# &zoneId =4
7# &apiKey =miVr 6X7u6bN_EJTVwZ 0nUkkJbPmY 3y2bciKwFQ
8# &signature =LXX 1DM 40AjcXU %2FcaiK 8RAP 0O1hU %3D
The line 1 corresponds to the point of entry (the link to the API b. Cloud Ikoula private ) The line 2 correspond a la command e a envoyer, ici on veut crée une nouvelle VM The line 3-6 correspondent aux différents paramètres de la command e. You can add the fields "response" which defined the return with the parameter format (XML /JSON ) The line 7 contains your API key (Here is an invalid example key, replace with your ) The line 8 est la signature générée à partir de la command e et de votre clé secrète
How to generate signature ?
We must ensure that all spaces are replaced by "%20" instead of "+"
To sort alphabetically sent fields. Attention to the settings one after the other separated by a & (Ampersand )and the string to lowercase.
Example of string parameters : apikey =mivr 6x7u6bn_ejtvwz 0nukkjbpmy 3y2bcikwfq &command =listvirtualmachines &Networkid =5
Finally apply a hmac_SHA 1 sur la chaîne générée avec comme clé de hashage votre clé secréte. Pour envoyer la requête il vous suffit de rajouter le champs signature avec la signature générée
$args is an associative array of all the arguments
// classement par clef
ksort($args);
$query = http_build_query($args);
// sécurité pour l'encodage des espaces
$query = str_replace("+", "%20", $query);
// minuscule
strtolower($query)
// calcul du hash
$hash = hash_hmac("SHA1", $query, $secretKey, true);
// encodage en base 64
$signature = base64_encode($hash);
?>
Enable comment auto-refresher