Comment utiliser l'API d’Ikoula - Historique des versions

Mschmit52a93 le 17 avril 2024 à 13:34

2024-04-17T13:34:39Z

Voir les modifications

Mschmit52a93 le 22 février 2021 à 15:51

2021-02-22T15:51:09Z

Mschmit52a93 : /* Wrapper PHP */

2021-02-22T15:46:40Z

Wrapper PHP

Woussen.alexis59c630e le 16 février 2021 à 11:21

2021-02-16T11:21:58Z

Lfourrea5593 le 15 février 2021 à 14:27

2021-02-15T14:27:55Z

Lfourrea5593 le 15 février 2021 à 11:16

2021-02-15T11:16:31Z

Lfourrea5593 le 12 février 2021 à 10:45

2021-02-12T10:45:28Z

Lfourrea5593 le 11 février 2021 à 16:34

2021-02-11T16:34:20Z

Mschmit52a93 : Page créée avec « == Introduction == Ikoula dispose d'une API permettant de réaliser des actions sur les produits associés à votre compte client. Voici l'URL de l'API: https://api.ikoul... »

2021-02-04T08:49:12Z

Page créée avec « == Introduction == Ikoula dispose d'une API permettant de réaliser des actions sur les produits associés à votre compte client. Voici l'URL de l'API: https://api.ikoul... »

Nouvelle page

== Introduction ==

Ikoula dispose d'une API permettant de réaliser des actions sur les produits associés à votre compte client.
Voici l'URL de l'API: https://api.ikoula.com

La documentation est disponible directement pour chaque produit.

==Explications==
Pour des raisons évidentes de {{Template:Sécurité}}, l'API Ikoula exige une authentification. Celle-ci est basée sur un identifiant, un mot de passe et une signature : 
* L'identifiant est l'adresse e-mail utilisée pour la connexion à votre compte Ikoula ou à l'Extranet. Le nom du paramètre pour le transmettre est toujours '''login''' ;
* Le mot de passe quant à lui doit être chiffré via une fonction spécifique utilisant une clé publique fournie par Ikoula (paramètre '''crypted_password''') et base64_encode ;
* La signature est générée en fonction des paramètres fournis lors de l'appel à l'API.
* Ces paramètres doivent toujours être passés en GET à l'API !

'''ATTENTION :'''

Pour vos tests de l'API, vous pouvez, par exemple, utiliser un utilisateur temporaire dédié à ces tests.
L'utilisation du chiffrement de mot de passe avec la clé publique Ikoula est indispensable dans tout contexte de production ou non-court terme. 
Si les appels API sont voués à être utilisés via un script ou un programme, nous vous recommandons la création d'un utilisateur dédié à cet effet plutôt que d'utiliser votre utilisateur extranet classique. 
Deux possibilités s'offrent à vous :
* Créer un sous-utilisateur directement depuis la page d'accueil de votre compte extranet (Voir le WIKI ci-après pour la création de sous-utilisateur: [[Comment créer des sous-utilisateurs via l'extranet d'Ikoula]]).
* Contacter notre support pour la création d'un utilisateur Extranet si besoin
Attention à ne pas oublier de lui mettre les droits sur les prestations souhaitées.

== Clé de chiffrement ==

La clé publique de chiffrement du mot de passe est disponible à l'adresse suivante: https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem

== Wrapper PHP ==

<syntaxhighlight lang="php">
<?php

// #################################################
// #### ..:: Ikoula Hosting Services ::.. ###
// #### Wrapper for https://api.ikoula.com ###
// #################################################

class IkoulaAPI {

/**
* Email of Ikoula account
* @var string Email account
*/
private static $email = "EMAIL_ACCOUNT_IKOULA";

/**
* Password of Ikoula account
* @var string Password account
*/
private static $password = "PASSWORD_ACCOUNT_IKOULA";

/**
* Ikoula API URI
* @var string Password account
*/
private static $urlApi = "https://api.ikoula.com/";

/** Public key path for encrypt data
* @var string Path of public key
* @see https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
*/
private static $publicKeyPath = "/path/to/ikoula/public/key/Ikoula.API.RSAKeyPub.pem";

/** Fonction for request Ikoula API
* @param string $webservice Webservice for data
* @param string $format JSON or XML
* @param string $type HTTP Type (GET/POST)
* @param array $params Params to add for request
*/
public static function requestApi($webservice, $format, $type, $params = [])
{
// Add connexion information
$params['login'] = self::$email;
$params['crypted_password'] = base64_encode(self::opensslEncryptPublic(self::$password));
$params['format'] = $format;

// Generate signature
$signature = self::createSignature($params);

// Add signature for call
$params['signature'] = $signature;

// Curl init
$ch = curl_init();

if($ch)
{
// Create API URI
$url = self::$urlApi.$webservice;

// Add type request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $type);

// If parameters, we encode his
if(is_array($params) && count($params) > 0)
$params_str = http_build_query($params);

// If we use post, fix params
if(strcasecmp("POST", $type) == 0)
{
// Fix POST data
curl_setopt($ch,CURLOPT_POST, true);
curl_setopt($ch,CURLOPT_POSTFIELDS, $params_str);
}
else
$url .= (strpos($url,'?') === false ? '?' : '&').$params_str;

// Create curl info
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_HEADER, false);

// Exec request
$data = curl_exec($ch);

// Close curl object
curl_close($ch);

// Return response
return($data);
}

return null;
}

/** Create signature with params
* @param array $params Params to add for request
* @return string Signature encoded
*/
private static function createSignature($params = [])
{
// Signature to send
$signature = null;

// Verify parameters
if (count($params) > 0)
{
// Sort params
ksort($params);

// Encode params
$query = http_build_query($params);

// Encode "plus "+"
$query = str_replace("+", "%20", $query);

// Transform in lowercase
$query = strtolower($query);

$public_key = "";

// Verify if key file is present
if (file_exists(self::$publicKeyPath))
{
// Get public key
$public_key = trim(
str_replace(
array("\n", '-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----'),
array('', '', ''),
file_get_contents(self::$publicKeyPath)
)
);
}

// SHA1 hash
$hash = hash_hmac("SHA1", $query, $public_key, true);

// base64 encode
$signature = base64_encode($hash);
}

return $signature;
}

/** Fonction for crypt Ikoula password
* @param string $password Ikoula account password
* @return mixed Ikoula password encrypted, null if error
*/
private static function opensslEncryptPublic($password)
{
// Verify if key file exist
if(file_exists(self::$publicKeyPath))
{
// Verify if password is not empty
if(!empty($password))
{
// Get file content
$publicKey = openssl_pkey_get_public('file://'.realpath(self::$publicKeyPath));

// If we get file content without error
if ($publicKey !== FALSE)
{
// Encrypt password
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
return $crypted;
else
return NULL;
}
else
return NULL;
}
else
return NULL;
}
else
return NULL;
}
}
</syntaxhighlight>

==Exemples d'utilisation==

<syntaxhighlight lang="php">

// Fix JSON header
header("Content-type: application/json");

// Get Exch schema for prestation
echo IkoulaAPI::requestApi("wsexch/schema-subscr", "json", "GET", ['subscr_id' => 999999999]);

// Get Flex VM for Ikoula Account
echo IkoulaAPI::requestApi("wsflex/list", "json", "GET", []);

// Get Flex VM for Ikoula Account
echo IkoulaAPI::requestApi("wsflex/list", "json", "GET", []);

// Get Platform list
echo IkoulaAPI::requestApi("wsplatform/list", "json", "GET", []);

// Get Platform dossiers
echo IkoulaAPI::requestApi("wsplatform/dossiers", "json", "GET", ['platform_id' => 999999999]);

// Get Billing conso for CloudStack prestation
echo IkoulaAPI::requestApi("wscs/conso-for-billing", "json", "GET", ['subscr_id' => '999999999', 'billing_id' => '1']);

// Reboot server
echo IkoulaAPI::requestApi("wsds/reboot-apc-request", "json", "GET", ['server_ip' => 'XXX.XXX.XXX.XXX', 'tempo' => '3']);
</syntaxhighlight>

== Ajout de fonctionnalités ==

En cas de demande de fonctionnalité, contactez le support technique.

← Version précédente		Version du 22 février 2021 à 15:51
Ligne 264 :		Ligne 264 :

	En cas de demande de fonctionnalité, contactez le support technique.		En cas de demande de fonctionnalité, contactez le support technique.
		+
		+	[[Category:API]]

@@ Ligne 4 : / Ligne 4 : @@
 <span data-link_translate_zh_title="如何使用Ikoula的API"  data-link_translate_zh_url="如何使用Ikoula的API"></span>[[:zh:如何使用Ikoula的API]][[zh:如何使用Ikoula的API]]
 <span data-link_translate_it_title="Come utilizzare l'API Ikoula"  data-link_translate_it_url="Come+utilizzare+l'API+Ikoula"></span>[[:it:Come utilizzare l'API Ikoula]][[it:Come utilizzare l'API Ikoula]]
 == Introduction ==

@@ Ligne 2 : / Ligne 2 : @@
 <span data-link_translate_es_title="Cómo utilizar la API de Ikoula"  data-link_translate_es_url="Cómo+utilizar+la+API+de+Ikoula"></span>[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
 <span data-link_translate_nl_title="Hoe de Ikoula API te gebruiken?"  data-link_translate_nl_url="Hoe+de+Ikoula+API+te+gebruiken?"></span>[[:nl:Hoe de Ikoula API te gebruiken?]][[nl:Hoe de Ikoula API te gebruiken?]]
 == Introduction ==

@@ Ligne 1 : / Ligne 1 : @@
 <span data-link_translate_en_title="How to use the Ikoula API"  data-link_translate_en_url="How+to+use+the+Ikoula+API"></span>[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
 <span data-link_translate_es_title="Cómo utilizar la API de Ikoula"  data-link_translate_es_url="Cómo+utilizar+la+API+de+Ikoula"></span>[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
 == Introduction ==

@@ Ligne 1 : / Ligne 1 : @@
 <span data-link_translate_en_title="How to use the Ikoula API"  data-link_translate_en_url="How+to+use+the+Ikoula+API"></span>[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
+<span data-link_translate_es_title="Cómo utilizar la API de Ikoula"  data-link_translate_es_url="Cómo+utilizar+la+API+de+Ikoula"></span>[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
 == Introduction ==

@@ Ligne 91 : / Ligne 91 : @@
 		$params['crypted_password'] = base64_encode(self::opensslEncryptPublic(self::$password));
 		$params['format'] = $format;
 		// Generate signature

← Version précédente		Version du 11 février 2021 à 16:34
Ligne 1 :		Ligne 1 :
		+	<span data-link_translate_en_title="How to use the Ikoula API" data-link_translate_en_url="How+to+use+the+Ikoula+API"></span>[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
		+
		+
	== Introduction ==		== Introduction ==