Ikoula Wiki - Contributions de l’utilisateur [fr]

Comment utiliser l'API d’Ikoula

2024-04-17T13:34:39Z

Mschmit52a93 :

[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
[[:nl:Hoe de Ikoula API te gebruiken?]][[nl:Hoe de Ikoula API te gebruiken?]]
[[:zh:如何使用Ikoula的API]][[zh:如何使用Ikoula的API]]
[[:it:Come utilizzare l'API Ikoula]][[it:Come utilizzare l'API Ikoula]]

{{#seo:
|title=Comment utiliser l'API d'IKOULA ?
|title_mode=append
|keywords=these,are,your,keywords
|description=Ikoula possède une API permettant de réaliser des actions sur les produits associés à votre compte client. Découvrez dans cet article comment utiliser correctement cet API.
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

== 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
* @param array|null $body
* @param bool $jsonBody
*/
public static function requestApi($webservice, $format, $method, $params = [], $body = null, $jsonBody = false)
{
// Add connexion information
$params['login'] = self::$email;
$params['crypted_password'] = base64_encode(self::opensslEncryptPublic(self::$password));
$params['format'] = $format;

// Fix params to lowercase for generate signature correctly
$params = array_change_key_case($params);

// Curl init
$ch = curl_init();

if($ch)
{
// Create API URI
$url = self::$urlApi.$webservice;
$url .= (str_contains($url, '?') ? '&' : '?') . http_build_query($params);

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

// If we use post, fix params
if(in_array($method, ['POST', 'PUT', 'DELETE'], true))
{
if($body !== null)
{
if(!$jsonBody)
{
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($body));
}
else
{
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
}
}
}

// 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;
}

/** 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.

[[Category:API]]

Comment créer des sous-utilisateurs via l'extranet d'Ikoula

2021-02-22T15:56:06Z

Mschmit52a93 :

[[:fr:Comment créer des sous-utilisateurs ?]][[fr:Comment créer des sous-utilisateurs ?]]
[[:he:כיצד ליצור חשבון משנה?]][[he:כיצד ליצור חשבון משנה?]]
[[:ro:Cum de a crea un sub-cont?]][[ro:Cum de a crea un sub-cont?]]
<span data-link_translate_ru_title="Как создать суб-аккаунт?" data-link_translate_ru_url="%D0%9A%D0%B0%D0%BA+%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D1%82%D1%8C+%D1%81%D1%83%D0%B1-%D0%B0%D0%BA%D0%BA%D0%B0%D1%83%D0%BD%D1%82%3F">[[:ru:Как создать суб-аккаунт?]][[ru:Как создать суб-аккаунт?]]
[[:pl:Jak stworzyć konto podrzędne?]][[pl:Jak stworzyć konto podrzędne?]]
<span data-link_translate_ja_title="サブアカウントを作成する方法?" data-link_translate_ja_url="%E3%82%B5%E3%83%96%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95%3F">[[:ja:サブアカウントを作成する方法?]][[ja:サブアカウントを作成する方法?]]
[[:ar:كيفية إنشاء حساب فرعي؟]][[ar:كيفية إنشاء حساب فرعي؟]]
[[:zh:如何创建一个子账户？]][[zh:如何创建一个子账户？]]
[[:de:So ein Unterkonto erstellen?]][[de:So ein Unterkonto erstellen?]]
[[:nl:Hoe maak je een subaccount?]][[nl:Hoe maak je een subaccount?]]
[[:it:Come creare un account secondario?]][[it:Come creare un account secondario?]]
[[:pt:Como criar uma subconta?]][[pt:Como criar uma subconta?]]
[[:es:¿Cómo crear una subcuenta?]][[es:¿Cómo crear una subcuenta?]]
[[:en:How to create a sub-account?]][[en:How to create a sub-account?]]


==Introduction==
Comment créer des sous-utilisateurs via l'extranet d'Ikoula

==Déroulé==
* Connectez-vous à [https://extranet.ikoula.com votre extranet Ikoula]
* Rendez-vous dans l'onglet [https://extranet.ikoula.com/index.php?r=site/sub-user '''''Gestion des sous-utilisateurs''''']
* Une fois sur la page, cliquez sur "Ajouter un utilisateur"

[[Fichier:sous utili.PNG]]

* Saisir les informations pour l'utilisateur

[[Fichier:add compte.PNG]]

* Une fois votre sous-utilisateur créé, vous pouvez modifier les informations de celui-ci quand vous le souhaitez.

[[Fichier:compte.PNG]]

* Dans cette page, vous pouvez activer ou désactiver le compte quand vous le souhaitez. C'est également ici que vous allez donner les droits d'accès au prestations pour cet utilisateur.

[[Fichier:modif.PNG]]

* Une fois les modifications effectuées, il suffit de cliquer sur le bouton "Modifier l'utilisateur" pour valider les modifications

 

Cet article vous a semblé utile ? <vote />

<comments />

[[Catégorie:Contribuer]] [[Catégorie:Linux]] -->

[[Catégorie:Plesk]]

[[Catégorie:Extranet]]

Accueil

2021-02-22T15:53:42Z

Mschmit52a93 : /* Liste des catégories principales */

[[:en:Special:Categories]][[en:Special:Categories]]
[[:es:Especial:Categorías]][[es:Especial:Categorías]]
[[:it:Speciale:Categorie]][[it:Speciale:Categorie]]
[[:nl:Speciaal:Categorieën]][[nl:Speciaal:Categorieën]]
[[:de:Spezial:Kategorien]][[de:Spezial:Kategorien]]
[[:pt:Especial:Categorias]][[pt:Especial:Categorias]]
[[:ru:Служебная:Категории]][[ru:Служебная:Категории]]
[[:pl:Specjalna:Kategorie]][[pl:Specjalna:Kategorie]]
[[:ro:Special:Categorii]][[ro:Special:Categorii]]
[[:zh:特殊:页面分类]][[zh:特殊:页面分类]]
[[:ja:特別:カテゴリ]][[ja:特別:カテゴリ]]
[[:he:מיוחד:קטגוריות]][[he:מיוחד:קטגוריות]]
[[:ar:خاص:تصنيفات]][[ar:خاص:تصنيفات]]

{{#seo:
|title=Wiki Ikoula sur nos différents services d'hébergement
|titlemode=replace
|keywords=wiki ikoula,ikoula wiki,base de connaissance ikoula
|description=Wiki Ikoula sur nos différents services d'hébergement
|og:type=article
|og:image=https://en-wiki.ikoula.com/resources/assets/logo_ikwiki.png
}}

<div>
<div class="intro">
=== Bienvenue sur la page wiki d'IKOULA !===
Que vous soyez client chez nous en quête d'informations sur nos produits, ou juste curieux d'en savoir plus sur le monde de l'Internet et plus particulièrement sur le Cloud et ses subtilités, cet espace est fait pour vous !

Parce que l'entraide et le partage des connaissances sont des valeurs fortes chez '''IKOULA''', nos geek specialists et nos équipes support ont préparé des fiches techniques et des tutoriels pour maîtriser l'ensemble des prestations que nous proposons, et plus encore !

Obtenir un nom de domaine, déployer une VM, commander un serveur dédié, se connecter à son interface client ou encore appréhender toutes les fonctionnalités de '''CLOUD IKOULA ONE''', voici quelques-uns des nombreux thèmes abordés ici !

Différentes catégories ont été créées. Chacune d'elles regroupent plusieurs articles balayant tous les points importants et nécessaires à connaître pour pouvoir profiter au maximum des services et produits '''IKOULA'''.
 
<div class="faqs">
Foire aux questions : Retrouvez ici les réponses aux questions les plus fréquentes <div class="lienfaqs">'''[https://fr-wiki.ikoula.com/fr/Foire_aux_questionsvoir toutes les questions]'''</div>
<div style="clear:both"></div>
</div>
 
</div>

<div class="publier">
=== IKOULA veut publier vos tutoriaux !===
Aidez nous à construire une base de connaissances, riche et compréhensible, autour de nos solutions.

Pas besoin d'être un auteur expérimenté : il vous suffit d'avoir des compétences techniques et l'envie de les partager.
Chaque article étant soumis à modération, nos techniciens vous aideront à la rédaction.

<div class="lien">
'''[https://fr-wiki.ikoula.com/fr/Ajouter_un_tutorielSoumettez vos articles maintenant !]'''
</div>
</div>
</div>

<div style="clear:both"></div>

=== Liste des catégories principales===
<div>
<div class="lienhome">
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Serveur_d%C3%A9di%C3%A9 Serveur dédié]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Synology Serveur Synology]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:FLEX Serveur Flex]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Cloud_priv%C3%A9 Cloud Privé]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Cloud_public Cloud Public]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Acronis_Backup Acronis Backup]
</div>
<div class="lienhome">
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:H%C3%A9bergement_mutualis%C3%A9 Hébergement mutualisé]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:IkeepInCloud IkeepInCloud]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Hosted_Exchange Hosted Exchange]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:R1Soft R1Soft]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Cloudstack Cloudstack]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:IPv6 IPv6]
</div>
<div class="lienhome">
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Plesk Plesk]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Extranet Extranet]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:API API]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Linux Linux]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Windows Windows]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Domaines Nom de domaine]
*[https://fr-wiki.ikoula.com/fr/Cat%C3%A9gorie:Mail Mail]

</div>
</div>
<div style="clear:both"> </div>
<div class="lien article">
'''[https://fr-wiki.ikoula.com/fr/Sp%C3%A9cial:Cat%C3%A9gories Voir toutes nos categories]'''
</div>
<div style="clear:both"> </div>

Génération de la signature

2021-02-22T15:52:47Z

Mschmit52a93 :

[[:fr:Génération de la signature]][[fr:Génération de la signature]]
[[:he:הדור חתימה]][[he:הדור חתימה]]
[[:ro:Generația semnături]][[ro:Generația semnături]]
[[:ru:Создание подписи]][[ru:Создание подписи]]
[[:pl:Generowanie podpisu]][[pl:Generowanie podpisu]]
[[:ja:署名の生成]][[ja:署名の生成]]
[[:ar:توليد التوقيع]][[ar:توليد التوقيع]]
[[:zh:签名生成]][[zh:签名生成]]
[[: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]]
[[:en:The signature generation]][[en:The signature generation]]


#REDIRECT [[Comment_utiliser_l'API_d’Ikoula]]

Architectures REST & WebService

2021-02-22T15:52:41Z

Mschmit52a93 :

[[:fr:Architectures REST & WebService]][[fr:Architectures REST & WebService]]
<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 ומנוחה]]
[[:ro:ODIHNĂ şi WebService arhitecturi]][[ro:ODIHNĂ şi WebService arhitecturi]]
<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 архитектуры]]
[[:pl:Architektury REST i WebService]][[pl:Architektury REST i 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 服务的体系结构]]
[[: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]]
[[:en:REST and WebService architectures]][[en:REST and WebService architectures]]


#REDIRECT [[Comment_utiliser_l'API_d’Ikoula]]

Authentification et sécurité

2021-02-22T15:52:30Z

Mschmit52a93 :

[[:fr:Authentification et sécurité]][[fr:Authentification et sécurité]]
[[:he:אבטחה ואימות]][[he:אבטחה ואימות]]
[[:ro:Autentificare și securitate]][[ro:Autentificare și securitate]]
<span data-link_translate_ru_title="Проверка подлинности и безопасность" data-link_translate_ru_url="%D0%9F%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0+%D0%BF%D0%BE%D0%B4%D0%BB%D0%B8%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8+%D0%B8+%D0%B1%D0%B5%D0%B7%D0%BE%D0%BF%D0%B0%D1%81%D0%BD%D0%BE%D1%81%D1%82%D1%8C">[[:ru:Проверка подлинности и безопасность]][[ru:Проверка подлинности и безопасность]]
[[:pl:Uwierzytelniania i zabezpieczeń]][[pl:Uwierzytelniania i zabezpieczeń]]
[[:ja:認証とセキュリティ]][[ja:認証とセキュリティ]]
[[:ar:الأمان والمصادقة]][[ar:الأمان والمصادقة]]
[[:zh:身份验证和安全]][[zh:身份验证和安全]]
[[:de:Authentifizierung und Sicherheit]][[de:Authentifizierung und Sicherheit]]
[[:nl:Verificatie en beveiliging]][[nl:Verificatie en beveiliging]]
[[:it:Autenticazione e protezione]][[it:Autenticazione e protezione]]
[[:pt:Autenticação e segurança]][[pt:Autenticação e segurança]]
[[:es:Autenticación y seguridad]][[es:Autenticación y seguridad]]
[[:en:Authentication and security]][[en:Authentication and security]]


{{#seo:
|title=Authentification et sécurité
|title_mode=append
|keywords=these,are,your,keywords
|description=Découvrez dans cet article à quoi correspond l'authentification à l'API Ikoula et quelles en sont les politiques de sécurité.
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

#REDIRECT [[Comment_utiliser_l'API_d’Ikoula]]

Comment utiliser l'API d’Ikoula

2021-02-22T15:51:09Z

Mschmit52a93 :

[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
[[:nl:Hoe de Ikoula API te gebruiken?]][[nl:Hoe de Ikoula API te gebruiken?]]
[[:zh:如何使用Ikoula的API]][[zh:如何使用Ikoula的API]]
[[:it:Come utilizzare l'API Ikoula]][[it:Come utilizzare l'API Ikoula]]

{{#seo:
|title=Comment utiliser l'API d'IKOULA ?
|title_mode=append
|keywords=these,are,your,keywords
|description=Ikoula possède une API permettant de réaliser des actions sur les produits associés à votre compte client. Découvrez dans cet article comment utiliser correctement cet API.
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

== 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;

// Fix params to lowercase for generate signature correctly
$params = array_change_key_case($params);

// 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.

[[Category:API]]

Exemples d'utilisation de l'API

2021-02-22T15:50:20Z

Mschmit52a93 :

[[:fr:Exemples d'utilisation de l'API]][[fr:Exemples d'utilisation de l'API]]
[[:he:דוגמאות לשימוש ה-API]][[he:דוגמאות לשימוש ה-API]]
[[:ro:Exemple de utilizare a API]][[ro:Exemple de utilizare a API]]
<span data-link_translate_ru_title="Примеры использования API" data-link_translate_ru_url="%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F+API">[[:ru:Примеры использования API]][[ru:Примеры использования API]]
[[:pl:Przykłady użycia interfejsu API]][[pl:Przykłady użycia interfejsu API]]
[[:ja:API を使用しての例]][[ja:API を使用しての例]]
[[:ar:أمثلة لاستخدام API]][[ar:أمثلة لاستخدام API]]
[[:zh:使用该 API 的示例]][[zh:使用该 API 的示例]]
[[:de:Beispiele für die Verwendung der API]][[de:Beispiele für die Verwendung der API]]
[[:nl:Voorbeelden van het gebruik van de API]][[nl:Voorbeelden van het gebruik van de API]]
[[:it:Esempi di utilizzo dell'API]][[it:Esempi di utilizzo dell'API]]
[[:pt:Exemplos de como usar a API]][[pt:Exemplos de como usar a API]]
[[:es:Ejemplos de uso de la API]][[es:Ejemplos de uso de la API]]
[[:en:Examples of using the API]][[en:Examples of using the API]]

#REDIRECT [[Comment_utiliser_l'API_d’Ikoula]]

Exemples d'utilisation de l'API

2021-02-22T15:50:00Z

Mschmit52a93 :

Comment utiliser l'API d’Ikoula

2021-02-22T15:46:40Z

Mschmit52a93 : /* Wrapper PHP */

[[:en:How to use the Ikoula API]][[en:How to use the Ikoula API]]
[[:es:Cómo utilizar la API de Ikoula]][[es:Cómo utilizar la API de Ikoula]]
[[:nl:Hoe de Ikoula API te gebruiken?]][[nl:Hoe de Ikoula API te gebruiken?]]
[[:zh:如何使用Ikoula的API]][[zh:如何使用Ikoula的API]]
[[:it:Come utilizzare l'API Ikoula]][[it:Come utilizzare l'API Ikoula]]

{{#seo:
|title=Comment utiliser l'API d'IKOULA ?
|title_mode=append
|keywords=these,are,your,keywords
|description=Ikoula possède une API permettant de réaliser des actions sur les produits associés à votre compte client. Découvrez dans cet article comment utiliser correctement cet API.
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}

== 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;

// Fix params to lowercase for generate signature correctly
$params = array_change_key_case($params);

// 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.

Comment utiliser l'API d’Ikoula

2021-02-04T08:49:12Z

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... »

== 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.

Test Traduction

2020-07-24T12:08:30Z

Mschmit52a93 : Page créée avec « Test traduction »

Test traduction

Fichier:Ikoula Logo.png

2019-08-13T06:37:02Z

Mschmit52a93 :

Vider son cache

2019-08-05T13:02:49Z

Mschmit52a93 :

[[:fr:Vider son cache]][[fr:Vider son cache]]
[[:he:לרוקן את המטמון]][[he:לרוקן את המטמון]]
[[:ro:Goliţi cache-ul său]][[ro:Goliţi cache-ul său]]
[[:ru:Очистить кэш]][[ru:Очистить кэш]]
[[:pl:Opróżnienia pamięci podręcznej]][[pl:Opróżnienia pamięci podręcznej]]
<span data-link_translate_ar_title="إفراغ ذاكرة التخزين المؤقتة" data-link_translate_ar_url="%D8%A5%D9%81%D8%B1%D8%A7%D8%BA+%D8%B0%D8%A7%D9%83%D8%B1%D8%A9+%D8%A7%D9%84%D8%AA%D8%AE%D8%B2%D9%8A%D9%86+%D8%A7%D9%84%D9%85%D8%A4%D9%82%D8%AA%D8%A9">[[:ar:إفراغ ذاكرة التخزين المؤقتة]][[ar:إفراغ ذاكرة التخزين المؤقتة]]
[[:zh:清空其缓存]][[zh:清空其缓存]]
[[:ja:そのキャッシュを空に]][[ja:そのキャッシュを空に]]
[[:de:Leeren Sie ihren cache]][[de:Leeren Sie ihren cache]]
== Introduction ==
Afin d'alléger certaines requêtes effectuées par les ordinateurs, un système de cache DNS, de mise en mémoire des adresses contactées, a été mis en place. Ce système peut poser certains problèmes lorsque les adresses mises en cache ne sont plus disponibles sur le réseau et que le cache n'a pas été actualisé.

== Vider son cache ==
<div style="background-color: #FFCC99;"> '''Note''': Pensez à redémarrer votre ordinateur après le vidage du cache DNS.</div>
=== Linux ===
Pour vider votre cache sous un environnement Linux il vous suffit d'ouvrir un terminal, tapez ensuite la commande suivante :
<syntaxhighlight lang="bash"> /etc/rc.d/init.d/nscd restart </syntaxhighlight>
ou
<syntaxhighlight lang="bash"> service nscd restart </syntaxhighlight>
En relançant le service NSCD le cache DNS sous Linux est vidé.
=== Mac OS X===
Pour vider votre cache sous un environnement Mac OS X, tapez dans un terminal:
==== Version Leopard ====
<syntaxhighlight lang="bash"> dscacheutil -flushcache </syntaxhighlight>
==== Autres versions ====
<syntaxhighlight lang="bash"> lookupd -flushcache </syntaxhighlight>
Le cache DNS sous Mac est maintenant vidé.

=== Windows ===
Pour vider votre cache sous un environnement Windows, ouvrez un terminal de commande en ouvrant le menu Démarrer -> Exécuter puis tapez cmd :
Dans la fenêtre du terminal qui est apparue tapez:
<syntaxhighlight lang="bash"> ipconfig /flushdns </syntaxhighlight>
Voilà votre cache DNS sous windows est maintenant vidé.
 
<div style="background-color: #FFCC99;"> '''Note''': Pensez à redémarrer votre ordinateur après le vidage du cache DNS.</div>

[[Catégorie:Windows]]
[[Catégorie:Linux]]
[[Catégorie:Mac OS]]
 
<comments />

Exemples d'utilisation de l'API

2016-12-23T12:57:05Z

Mschmit52a93 :

[[:he:דוגמאות לשימוש ה-API]][[he:דוגמאות לשימוש ה-API]]
[[:ro:Exemple de utilizare a API]][[ro:Exemple de utilizare a API]]
<span data-link_translate_ru_title="Примеры использования API" data-link_translate_ru_url="%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F+API">[[:ru:Примеры использования API]][[ru:Примеры использования API]]
[[:pl:Przykłady użycia interfejsu API]][[pl:Przykłady użycia interfejsu API]]
[[:ja:API を使用しての例]][[ja:API を使用しての例]]
[[:ar:أمثلة لاستخدام API]][[ar:أمثلة لاستخدام API]]
[[:zh:使用该 API 的示例]][[zh:使用该 API 的示例]]
[[:de:Beispiele für die Verwendung der API]][[de:Beispiele für die Verwendung der API]]
[[:nl:Voorbeelden van het gebruik van de API]][[nl:Voorbeelden van het gebruik van de API]]
[[:it:Esempi di utilizzo dell'API]][[it:Esempi di utilizzo dell'API]]
[[:pt:Exemplos de como usar a API]][[pt:Exemplos de como usar a API]]
[[:es:Ejemplos de uso de la API]][[es:Ejemplos de uso de la API]]
[[:en:Examples of using the API]][[en:Examples of using the API]]

==Introduction==
Comment utiliser l'API à travers quelques exemples concrets et fonctionnels.

==Fonctions pour les exemples==
<syntaxhighlight lang="php">
// Chemin local vers la clé publique téléchargée sur https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de chiffrement du mot de passe via la clé publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clé publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupère la clé public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// S'il n'y as pas eu d'erreurs lors de la récupération de la clé publique, on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clé publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du mot de passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur - la clé publique n'est pas présente.\n");
return NULL;
}
}

// Fontction de création de la signature en fonction des paramètres présents
function createSignature($params=array())
{
$signature = null;

// Si il y a au moins un paramètre
if (count($params) > 0)
{
//debug('create signature');
//debug($params);

// Triage des paramètres dans le sens croissant
ksort($params);

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

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

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

$public_key = "";
// Si le fichier existe, on va récupérer la clé
if (file_exists(API_PUB_KEY_PATH))
{
$public_key = trim(
str_replace(
array("\n", '-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----'),
array('', '', ''),
file_get_contents(API_PUB_KEY_PATH)
)
);
}

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

// Encodage en base64
$signature = base64_encode($hash);
}

return $signature;
}

// Fonction facilitant l'envoie des requêtes vers l'API Ikoula
function send_request ($rest, $url_param, $params=array())
{
// initialisation de CURL
$ch = curl_init();
if($ch)
{
// Si on a des info on utilise l'api REST sinon on utilise l'api standard (WebService)
if($rest)
$url = "https://api.ikoula.com/rest/" . $url_param;
else
$url = "https://api.ikoula.com/?r=" . $url_param;

// si on est en REST on rajoute le type d'appel (POST,DELETE,PUT,GET,...) sinon on passe en POST
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ($rest)?$rest:"POST");
// Si il y a des paramètres on les rajoute dans la requête
if(is_array($params) && count($params) > 0)
{
$params_str = http_build_query($params);
}
if($rest=='POST')
{
// on rentre le nom de paramètre présent dans la requête
curl_setopt($ch,CURLOPT_POST, true);
curl_setopt($ch,CURLOPT_POSTFIELDS, $params_str);
}
else
{
$url .= (strpos($url,'?') === false ? '?' : '&').$params_str;
}

// On ajoute l'url
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);
// on vire les en-tête HTTP pour avoir directement le retour
curl_setopt($ch, CURLOPT_HEADER, false);

// exécution de la requête
$data = curl_exec($ch);

// fermeture de l'objet
curl_close($ch);

// retourne la réponse
return($data);
}
return null;
}
</syntaxhighlight>

==Appels API==
<syntaxhighlight lang="php">
// Login
$login = 'mail@test.com';

// On crypte le mot de passe
$crypted_password = base64_encode(opensslEncryptPublic('MOT_DE_PASSE_A_CRYPTER'));

// Liste des VM - retour en JSON
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsflex/vmlist',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/list',$parameters);
print_r($data2); //appel REST

// Informations d'une VM - retour en XML
//liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'xml', 'subscr_id' => 12345);
//on génère la signature
$signature = createSignature($parameters);
//on ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
//on fait l'appel API
$data = send_request(false,'wsflex/vminfo',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Information sur une prestation Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/getschemasubscrexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','exch/schemasubscrexchange/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Ajouter une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'new_bal@domain.tld', 'orga_id' => 'orga_id', 'display_name' => 'Name for Bal', 'mail_send_installation' => 'emailto_reveive_info@domain.tld', 'password_bal' => 'PASSWORD_BAL');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/addbalexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/addbalexchange/'.$parameters['email_bal'].'/'.$parameters['password_bal'].'/'.urlencode($parameters['display_name']).'/'.$parameters['orga_id'], $parameters);
print_r($data2); //appel REST

// Changer le password d'une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'sousclient4@orga31.ex10.biz', 'password_bal' => 'r7ttlJOKYQZd');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/ChangeExchangePassword',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/changeexchangepassword/'.$parameters['email_bal'].'/'.$parameters['password_bal'],$parameters);
print_r($data2); //appel REST

// Récupérer les prestations IKIC du compte
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/GetListIkic',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/list/',$parameters);
print_r($data2); //appel REST

// Récupérer les statistiques d'une prestation
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/datastats',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/datastats/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Récupération des plateformes
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformList',$parameters);
$data2 = send_request('GET','platform/list/',$parameters);
print_r($data); //appel WebService
print_r($data2); //appel REST

// Récupération des webscenarios
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'platform_id' => 000);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformWebscenarios',$parameters);
$data2 = send_request('GET','platform/webscenarios/'.$parameters['platform_id'],$parameters);
print_r($data); //appel WebService
print_r($data2); //appel REST

// Récupération des détails d'une plateforme
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'platform_id' => 000);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformDetails',$parameters);
$data2 = send_request('GET','platform/details/'.$parameters['platform_id'],$parameters);

// Récupération des prestations R1Soft
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsr1soft/GetR1softList',$parameters);
$data2 = send_request('GET','r1soft/list/',$parameters);

// Récupération des détails d'une prestation R1Soft
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 9999999);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsr1soft/GetR1softSubscr',$parameters);
$data2 = send_request('GET','r1soft/details/'.$parameters['subscr_id'],$parameters);

// Récupération des prestations SSL
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsssl/GetSslList',$parameters);
$data2 = send_request('GET','ssl/list/',$parameters);

// Récupération des détails d'une prestation SSL
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 9999999);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsssl/GetSslSubscr',$parameters);
$data2 = send_request('GET','ssl/details/'.$parameters['subscr_id'],$parameters);

// Récupération des prestations HEB
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsheb/GetHebList',$parameters);
$data2 = send_request('GET','heb/list/',$parameters);

// Récupération des détails d'une prestation HEB
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 9999999);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsheb/GetHebSubscr',$parameters);
$data2 = send_request('GET','heb/details/'.$parameters['subscr_id'],$parameters);

// Récupération des prestations NDD
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsndd/GetNddList',$parameters);
$data2 = send_request('GET','ndd/list/',$parameters);

// Récupération des détails d'une prestation NDD
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 9999999);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsndd/GetNddSubscr',$parameters);
$data2 = send_request('GET','ndd/details/'.$parameters['subscr_id'],$parameters);

</syntaxhighlight>

==Erreurs usuelles==
;Permission Denied
: Signifie que l'utilisateur utilisé dans l'API n'a pas le droit d'accéder à l'information demandée ou d'effectuer l'action souhaitée.
;Unable to decrypt password
: Signifie que le paramètre '''crypted_password''' a été mal crypté ou corrompu.
;Invalid credentials
: Signifie que l'authentification a échoué et que l'utilisateur n'est donc pas reconnu.
;Invalid or missing signature
: Signifie que la signature n'est pas présente dans les paramètres reçus par l'API, ou que celle-ci est invalide.
 D'autres remontées d'erreurs sont possibles mais seront contextuelles en fonction de la fonctionnalité souhaitée.


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Exemples d'utilisation de l'API

2016-11-29T14:03:14Z

Mschmit52a93 :

[[:he:דוגמאות לשימוש ה-API]][[he:דוגמאות לשימוש ה-API]]
[[:ro:Exemple de utilizare a API]][[ro:Exemple de utilizare a API]]
<span data-link_translate_ru_title="Примеры использования API" data-link_translate_ru_url="%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F+API">[[:ru:Примеры использования API]][[ru:Примеры использования API]]
[[:pl:Przykłady użycia interfejsu API]][[pl:Przykłady użycia interfejsu API]]
[[:ja:API を使用しての例]][[ja:API を使用しての例]]
[[:ar:أمثلة لاستخدام API]][[ar:أمثلة لاستخدام API]]
[[:zh:使用该 API 的示例]][[zh:使用该 API 的示例]]
[[:de:Beispiele für die Verwendung der API]][[de:Beispiele für die Verwendung der API]]
[[:nl:Voorbeelden van het gebruik van de API]][[nl:Voorbeelden van het gebruik van de API]]
[[:it:Esempi di utilizzo dell'API]][[it:Esempi di utilizzo dell'API]]
[[:pt:Exemplos de como usar a API]][[pt:Exemplos de como usar a API]]
[[:es:Ejemplos de uso de la API]][[es:Ejemplos de uso de la API]]
[[:en:Examples of using the API]][[en:Examples of using the API]]

==Introduction==
Comment utiliser l'API à travers quelques exemples concrets et fonctionnels.

==Fonctions pour les exemples==
<syntaxhighlight lang="php">
// Chemin local vers la clé publique téléchargée sur https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de chiffrement du mot de passe via la clé publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clé publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupère la clé public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// S'il n'y as pas eu d'erreurs lors de la récupération de la clé publique, on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clé publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du mot de passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur - la clé publique n'est pas présente.\n");
return NULL;
}
}

// Fontction de création de la signature en fonction des paramètres présents
function createSignature($params=array())
{
$signature = null;

// Si il y a au moins un paramètre
if (count($params) > 0)
{
//debug('create signature');
//debug($params);

// Triage des paramètres dans le sens croissant
ksort($params);

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

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

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

$public_key = "";
// Si le fichier existe, on va récupérer la clé
if (file_exists(API_PUB_KEY_PATH))
{
$public_key = trim(
str_replace(
array("\n", '-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----'),
array('', '', ''),
file_get_contents(API_PUB_KEY_PATH)
)
);
}

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

// Encodage en base64
$signature = base64_encode($hash);
}

return $signature;
}

// Fonction facilitant l'envoie des requêtes vers l'API Ikoula
function send_request ($rest, $url_param, $params=array())
{
// initialisation de CURL
$ch = curl_init();
if($ch)
{
// Si on a des info on utilise l'api REST sinon on utilise l'api standard (WebService)
if($rest)
$url = "https://api.ikoula.com/rest/" . $url_param;
else
$url = "https://api.ikoula.com/?r=" . $url_param;

// si on est en REST on rajoute le type d'appel (POST,DELETE,PUT,GET,...) sinon on passe en POST
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ($rest)?$rest:"POST");
// Si il y a des paramètres on les rajoute dans la requête
if(is_array($params) && count($params) > 0)
{
$params_str = http_build_query($params);
}
if($rest=='POST')
{
// on rentre le nom de paramètre présent dans la requête
curl_setopt($ch,CURLOPT_POST, true);
curl_setopt($ch,CURLOPT_POSTFIELDS, $params_str);
}
else
{
$url .= (strpos($url,'?') === false ? '?' : '&').$params_str;
}

// On ajoute l'url
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);
// on vire les en-tête HTTP pour avoir directement le retour
curl_setopt($ch, CURLOPT_HEADER, false);

// exécution de la requête
$data = curl_exec($ch);

// fermeture de l'objet
curl_close($ch);

// retourne la réponse
return($data);
}
return null;
}
</syntaxhighlight>

==Appels API==
<syntaxhighlight lang="php">
// Login
$login = 'mail@test.com';

// On crypte le mot de passe
$crypted_password = base64_encode(opensslEncryptPublic('MOT_DE_PASSE_A_CRYPTER'));

// Liste des VM - retour en JSON
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsflex/vmlist',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/list',$parameters);
print_r($data2); //appel REST

// Informations d'une VM - retour en XML
//liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'xml', 'subscr_id' => 12345);
//on génère la signature
$signature = createSignature($parameters);
//on ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
//on fait l'appel API
$data = send_request(false,'wsflex/vminfo',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Information sur une prestation Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/getschemasubscrexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','exch/schemasubscrexchange/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Ajouter une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'new_bal@domain.tld', 'orga_id' => 'orga_id', 'display_name' => 'Name for Bal', 'mail_send_installation' => 'emailto_reveive_info@domain.tld', 'password_bal' => 'PASSWORD_BAL');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/addbalexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/addbalexchange/'.$parameters['email_bal'].'/'.$parameters['password_bal'].'/'.urlencode($parameters['display_name']).'/'.$parameters['orga_id'], $parameters);
print_r($data2); //appel REST

// Changer le password d'une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'sousclient4@orga31.ex10.biz', 'password_bal' => 'r7ttlJOKYQZd');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/ChangeExchangePassword',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/changeexchangepassword/'.$parameters['email_bal'].'/'.$parameters['password_bal'],$parameters);
print_r($data2); //appel REST

// Récupérer les prestations IKIC du compte
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/GetListIkic',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/list/',$parameters);
print_r($data2); //appel REST

// Récupérer les statistiques d'une prestation
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/datastats',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/datastats/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Récupération des plateformes
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformList',$parameters);
$data2 = send_request('GET','platform/list/',$parameters);
print_r($data); //appel WebService
print_r($data2); //appel REST

// Récupération des webscenarios
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'platform_id' => 000);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformWebscenarios',$parameters);
$data2 = send_request('GET','platform/webscenarios/'.$parameters['platform_id'],$parameters);
print_r($data); //appel WebService
print_r($data2); //appel REST

// Récupération des détails d'une plateforme
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'platform_id' => 000);
$signature = createSignature($parameters);
$parameters['signature'] = $signature;
$data = send_request(false,'wsplatform/GetPlatformDetails',$parameters);
$data2 = send_request('GET','platform/details/'.$parameters['platform_id'],$parameters);

</syntaxhighlight>

==Erreurs usuelles==
;Permission Denied
: Signifie que l'utilisateur utilisé dans l'API n'a pas le droit d'accéder à l'information demandée ou d'effectuer l'action souhaitée.
;Unable to decrypt password
: Signifie que le paramètre '''crypted_password''' a été mal crypté ou corrompu.
;Invalid credentials
: Signifie que l'authentification a échoué et que l'utilisateur n'est donc pas reconnu.
;Invalid or missing signature
: Signifie que la signature n'est pas présente dans les paramètres reçus par l'API, ou que celle-ci est invalide.
 D'autres remontées d'erreurs sont possibles mais seront contextuelles en fonction de la fonctionnalité souhaitée.


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Exemples d'utilisation de l'API

2016-10-19T11:39:48Z

Mschmit52a93 : /* Appels API */

[[:he:דוגמאות לשימוש ה-API]][[he:דוגמאות לשימוש ה-API]]
[[:ro:Exemple de utilizare a API]][[ro:Exemple de utilizare a API]]
<span data-link_translate_ru_title="Примеры использования API" data-link_translate_ru_url="%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F+API">[[:ru:Примеры использования API]][[ru:Примеры использования API]]
[[:pl:Przykłady użycia interfejsu API]][[pl:Przykłady użycia interfejsu API]]
[[:ja:API を使用しての例]][[ja:API を使用しての例]]
[[:ar:أمثلة لاستخدام API]][[ar:أمثلة لاستخدام API]]
[[:zh:使用该 API 的示例]][[zh:使用该 API 的示例]]
[[:de:Beispiele für die Verwendung der API]][[de:Beispiele für die Verwendung der API]]
[[:nl:Voorbeelden van het gebruik van de API]][[nl:Voorbeelden van het gebruik van de API]]
[[:it:Esempi di utilizzo dell'API]][[it:Esempi di utilizzo dell'API]]
[[:pt:Exemplos de como usar a API]][[pt:Exemplos de como usar a API]]
[[:es:Ejemplos de uso de la API]][[es:Ejemplos de uso de la API]]
[[:en:Examples of using the API]][[en:Examples of using the API]]



==Introduction==
Comment utiliser l'API à travers quelques exemples concrets et fonctionnels.

==Fonctions pour les exemples==
<syntaxhighlight lang="php">
// Chemin local vers la clé publique téléchargée sur https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de chiffrement du mot de passe via la clé publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clé publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupère la clé public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// S'il n'y as pas eu d'erreurs lors de la récupération de la clé publique, on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clé publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du mot de passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur - la clé publique n'est pas présente.\n");
return NULL;
}
}

// Fontction de création de la signature en fonction des paramètres présents
function createSignature($params=array())
{
$signature = null;

// Si il y a au moins un paramètre
if (count($params) > 0)
{
//debug('create signature');
//debug($params);

// Triage des paramètres dans le sens croissant
ksort($params);

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

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

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

$public_key = "";
// Si le fichier existe, on va récupérer la clé
if (file_exists(API_PUB_KEY_PATH))
{
$public_key = trim(
str_replace(
array("\n", '-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----'),
array('', '', ''),
file_get_contents(API_PUB_KEY_PATH)
)
);
}

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

// Encodage en base64
$signature = base64_encode($hash);
}

return $signature;
}

// Fonction facilitant l'envoie des requêtes vers l'API Ikoula
function send_request ($rest, $url_param, $params=array())
{
// initialisation de CURL
$ch = curl_init();
if($ch)
{
// Si on a des info on utilise l'api REST sinon on utilise l'api standard (WebService)
if($rest)
$url = "https://api.ikoula.com/rest/" . $url_param;
else
$url = "https://api.ikoula.com/?r=" . $url_param;

// si on est en REST on rajoute le type d'appel (POST,DELETE,PUT,GET,...) sinon on passe en POST
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ($rest)?$rest:"POST");
// Si il y a des paramètres on les rajoute dans la requête
if(is_array($params) && count($params) > 0)
{
$params_str = http_build_query($params);
}
if($rest=='POST')
{
// on rentre le nom de paramètre présent dans la requête
curl_setopt($ch,CURLOPT_POST, true);
curl_setopt($ch,CURLOPT_POSTFIELDS, $params_str);
}
else
{
$url .= (strpos($url,'?') === false ? '?' : '&').$params_str;
}

// On ajoute l'url
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);
// on vire les en-tête HTTP pour avoir directement le retour
curl_setopt($ch, CURLOPT_HEADER, false);

// exécution de la requête
$data = curl_exec($ch);

// fermeture de l'objet
curl_close($ch);

// retourne la réponse
return($data);
}
return null;
}
</syntaxhighlight>

==Appels API==
<syntaxhighlight lang="php">
// Login
$login = 'mail@test.com';

// On crypte le mot de passe
$crypted_password = base64_encode(opensslEncryptPublic('MOT_DE_PASSE_A_CRYPTER'));

// Liste des VM - retour en JSON
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsflex/vmlist',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/list',$parameters);
print_r($data2); //appel REST

// Informations d'une VM - retour en XML
//liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'xml', 'subscr_id' => 12345);
//on génère la signature
$signature = createSignature($parameters);
//on ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
//on fait l'appel API
$data = send_request(false,'wsflex/vminfo',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Information sur une prestation Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/getschemasubscrexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','exch/schemasubscrexchange/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Ajouter une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'new_bal@domain.tld', 'orga_id' => 'orga_id', 'display_name' => 'Name for Bal', 'mail_send_installation' => 'emailto_reveive_info@domain.tld', 'password_bal' => 'PASSWORD_BAL');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/addbalexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/addbalexchange/'.$parameters['email_bal'].'/'.$parameters['password_bal'].'/'.urlencode($parameters['display_name']).'/'.$parameters['orga_id'], $parameters);
print_r($data2); //appel REST

// Changer le password d'une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'sousclient4@orga31.ex10.biz', 'password_bal' => 'r7ttlJOKYQZd');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/ChangeExchangePassword',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/changeexchangepassword/'.$parameters['email_bal'].'/'.$parameters['password_bal'],$parameters);
print_r($data2); //appel REST

// Récupérer les prestations IKIC du compte
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/GetListIkic',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/list/',$parameters);
print_r($data2); //appel REST

// Récupérer les statistiques d'une prestation
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/datastats',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/datastats/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

</syntaxhighlight>

==Erreurs usuelles==
;Permission Denied
: Signifie que l'utilisateur utilisé dans l'API n'a pas le droit d'accéder à l'information demandée ou d'effectuer l'action souhaitée.
;Unable to decrypt password
: Signifie que le paramètre '''crypted_password''' a été mal crypté ou corrompu.
;Invalid credentials
: Signifie que l'authentification a échoué et que l'utilisateur n'est donc pas reconnu.
;Invalid or missing signature
: Signifie que la signature n'est pas présente dans les paramètres reçus par l'API, ou que celle-ci est invalide.
 D'autres remontées d'erreurs sont possibles mais seront contextuelles en fonction de la fonctionnalité souhaitée.


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Exemples d'utilisation de l'API

2016-10-19T11:37:42Z

Mschmit52a93 : /* Appels API */

[[:he:דוגמאות לשימוש ה-API]][[he:דוגמאות לשימוש ה-API]]
[[:ro:Exemple de utilizare a API]][[ro:Exemple de utilizare a API]]
<span data-link_translate_ru_title="Примеры использования API" data-link_translate_ru_url="%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F+API">[[:ru:Примеры использования API]][[ru:Примеры использования API]]
[[:pl:Przykłady użycia interfejsu API]][[pl:Przykłady użycia interfejsu API]]
[[:ja:API を使用しての例]][[ja:API を使用しての例]]
[[:ar:أمثلة لاستخدام API]][[ar:أمثلة لاستخدام API]]
[[:zh:使用该 API 的示例]][[zh:使用该 API 的示例]]
[[:de:Beispiele für die Verwendung der API]][[de:Beispiele für die Verwendung der API]]
[[:nl:Voorbeelden van het gebruik van de API]][[nl:Voorbeelden van het gebruik van de API]]
[[:it:Esempi di utilizzo dell'API]][[it:Esempi di utilizzo dell'API]]
[[:pt:Exemplos de como usar a API]][[pt:Exemplos de como usar a API]]
[[:es:Ejemplos de uso de la API]][[es:Ejemplos de uso de la API]]
[[:en:Examples of using the API]][[en:Examples of using the API]]



==Introduction==
Comment utiliser l'API à travers quelques exemples concrets et fonctionnels.

==Fonctions pour les exemples==
<syntaxhighlight lang="php">
// Chemin local vers la clé publique téléchargée sur https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de chiffrement du mot de passe via la clé publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clé publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupère la clé public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// S'il n'y as pas eu d'erreurs lors de la récupération de la clé publique, on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clé publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du mot de passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur - la clé publique n'est pas présente.\n");
return NULL;
}
}

// Fontction de création de la signature en fonction des paramètres présents
function createSignature($params=array())
{
$signature = null;

// Si il y a au moins un paramètre
if (count($params) > 0)
{
//debug('create signature');
//debug($params);

// Triage des paramètres dans le sens croissant
ksort($params);

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

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

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

$public_key = "";
// Si le fichier existe, on va récupérer la clé
if (file_exists(API_PUB_KEY_PATH))
{
$public_key = trim(
str_replace(
array("\n", '-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----'),
array('', '', ''),
file_get_contents(API_PUB_KEY_PATH)
)
);
}

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

// Encodage en base64
$signature = base64_encode($hash);
}

return $signature;
}

// Fonction facilitant l'envoie des requêtes vers l'API Ikoula
function send_request ($rest, $url_param, $params=array())
{
// initialisation de CURL
$ch = curl_init();
if($ch)
{
// Si on a des info on utilise l'api REST sinon on utilise l'api standard (WebService)
if($rest)
$url = "https://api.ikoula.com/rest/" . $url_param;
else
$url = "https://api.ikoula.com/?r=" . $url_param;

// si on est en REST on rajoute le type d'appel (POST,DELETE,PUT,GET,...) sinon on passe en POST
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ($rest)?$rest:"POST");
// Si il y a des paramètres on les rajoute dans la requête
if(is_array($params) && count($params) > 0)
{
$params_str = http_build_query($params);
}
if($rest=='POST')
{
// on rentre le nom de paramètre présent dans la requête
curl_setopt($ch,CURLOPT_POST, true);
curl_setopt($ch,CURLOPT_POSTFIELDS, $params_str);
}
else
{
$url .= (strpos($url,'?') === false ? '?' : '&').$params_str;
}

// On ajoute l'url
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);
// on vire les en-tête HTTP pour avoir directement le retour
curl_setopt($ch, CURLOPT_HEADER, false);

// exécution de la requête
$data = curl_exec($ch);

// fermeture de l'objet
curl_close($ch);

// retourne la réponse
return($data);
}
return null;
}
</syntaxhighlight>

==Appels API==
<syntaxhighlight lang="php">
// Login
$login = 'mail@test.com';

// On crypte le mot de passe
$crypted_password = base64_encode(opensslEncryptPublic('MOT_DE_PASSE_A_CRYPTER'));

// Liste des VM - retour en JSON
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsflex/vmlist',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/list',$parameters);
print_r($data2); //appel REST

// Informations d'une VM - retour en XML
//liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'xml', 'subscr_id' => 12345);
//on génère la signature
$signature = createSignature($parameters);
//on ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
//on fait l'appel API
$data = send_request(false,'wsflex/vminfo',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','vm/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Information sur une prestation Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/getschemasubscrexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','exch/schemasubscrexchange/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Ajouter une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'new_bal@domain.tld', 'orga_id' => 'orga_id', 'display_name' => 'Name for Bal', 'mail_send_installation' => 'emailto_reveive_info@domain.tld', 'password_bal' => 'PASSWORD_BAL');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/getschemasubscrexchange',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','exch/schemasubscrexchange/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

// Changer le password d'une BAL Exchange
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'email_bal' => 'sousclient4@orga31.ex10.biz', 'password_bal' => 'r7ttlJOKYQZd');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsexch/ChangeExchangePassword',$parameters);
print_r($data); //appel WebService
$data2 = send_request('POST','exch/changeexchangepassword/'.$parameters['email_bal'].'/'.$parameters['password_bal'],$parameters);
print_r($data2); //appel REST

// Récupérer les prestations IKIC du compte
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json');
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/GetListIkic',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/list/',$parameters);
print_r($data2); //appel REST

// Récupérer les statistiques d'une prestation
// Liste des paramètres que l'on souhaite envoyer à l'API (pour générer la signature)
$parameters = array('login' => $login, 'crypted_password' => $crypted_password, 'format' => 'json', 'subscr_id' => 12345);
// On génère la signature
$signature = createSignature($parameters);
// On ajoute la signature dans les paramètres à envoyer lors de l'appel à l'API
$parameters['signature'] = $signature;
// On fait l'appel API
$data = send_request(false,'wsikic/datastats',$parameters);
print_r($data); //appel WebService
$data2 = send_request('GET','ikic/datastats/'.$parameters['subscr_id'],$parameters);
print_r($data2); //appel REST

</syntaxhighlight>

==Erreurs usuelles==
;Permission Denied
: Signifie que l'utilisateur utilisé dans l'API n'a pas le droit d'accéder à l'information demandée ou d'effectuer l'action souhaitée.
;Unable to decrypt password
: Signifie que le paramètre '''crypted_password''' a été mal crypté ou corrompu.
;Invalid credentials
: Signifie que l'authentification a échoué et que l'utilisateur n'est donc pas reconnu.
;Invalid or missing signature
: Signifie que la signature n'est pas présente dans les paramètres reçus par l'API, ou que celle-ci est invalide.
 D'autres remontées d'erreurs sont possibles mais seront contextuelles en fonction de la fonctionnalité souhaitée.


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Exemples d'utilisation de l'API

2016-10-19T09:44:35Z

Mschmit52a93 : /* Fonctions pour les exemples */

Génération de la signature

2016-10-19T09:42:23Z

Mschmit52a93 :

[[:he:הדור חתימה]][[he:הדור חתימה]]
[[:ro:Generația semnături]][[ro:Generația semnături]]
[[:ru:Создание подписи]][[ru:Создание подписи]]
[[:pl:Generowanie podpisu]][[pl:Generowanie podpisu]]
[[:ja:署名の生成]][[ja:署名の生成]]
[[:ar:توليد التوقيع]][[ar:توليد التوقيع]]
[[:zh:签名生成]][[zh:签名生成]]
[[: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]]
[[:en:The signature generation]][[en:The signature generation]]


==Introduction==
Lors d'un appel à l'API, comme indiqué dans le Wiki de l'authentification, une signature est obligatoire. Elle est générée '''en fonction de l'ensemble des paramètres fournis lors de l'appel'''. 
Pour des raisons techniques, les paramètres d'authentification doivent ''pour l'instant'' toujours être transmises via la méthode HTTP GET.

==Exemple==

<syntaxhighlight lang="php">
// Définition des paramètres
$data["login"] = "mail@example.com";
$data["password"] = "dh4=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==
Une fois la signature générée, il faut la passer en paramètre (en plus de tous les autres paramètres) à l'appel API. 
En suivant l'exemple précédent, les paramètres à passer auraient donc été : 
* login = "mail@example.com" ;
* password = "dh4=674j_G" ;
* signature = $signature.


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Architectures REST & WebService

2016-10-19T09:41:02Z

Mschmit52a93 :

<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 ומנוחה]]
[[:ro:ODIHNĂ şi WebService arhitecturi]][[ro:ODIHNĂ şi WebService arhitecturi]]
<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 архитектуры]]
[[:pl:Architektury REST i WebService]][[pl:Architektury REST i 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 服务的体系结构]]
[[: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]]
[[:en:REST and WebService architectures]][[en:REST and WebService architectures]]


==Introduction==
Avec quelle architecture l'API est-elle compatible ?

==Explication==
L'API Ikoula propose une approche suivant deux architectures : WebService & REST.

==WebService==
L'architecture WebService s'utilise :
* Soit en GET (en formatant les paramètres directement dans l'URI) '''obligatoire pour les paramètres d'authentification''' ;
* Soit en POST (en passant les paramètres en tableau de données) ;
* Soit en mixant les deux (paramètres présents en GET et en POST).
 Voici quelques exemples :
;Lister les VM d'un compte
: https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx
;Récupération des informations d'une VM en utilisant son nom
: 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. 
Voici quelques exemples : 

;Retourne le statut de la VM "vmid"
: GET /rest/vm/:vmid
;Démarre la VM "vmid"
: POST /rest/vm/:vmid/status/start
;Supprime le snapshot "snapshotName" de la VM "vmid"
: DELETE /rest/vm/:vmid/snapshot/:snapshotName

En passant les paramètres d'authentification (voir WIKI sur l'[[Authentification_et_sécurité|Authentification et la sécurité]] pour plus de détails), voici un exemple d'URL : 
https://api.ikoula.com/rest/vm/list?login=mail@example.com&crypted_password=encrypted_password&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxx


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]




<comments />

Exemples d'utilisation de l'API

2016-10-19T09:40:21Z

Mschmit52a93 :

Authentification et sécurité

2016-10-19T09:39:18Z

Mschmit52a93 :

[[:he:אבטחה ואימות]][[he:אבטחה ואימות]]
[[:ro:Autentificare și securitate]][[ro:Autentificare și securitate]]
<span data-link_translate_ru_title="Проверка подлинности и безопасность" data-link_translate_ru_url="%D0%9F%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0+%D0%BF%D0%BE%D0%B4%D0%BB%D0%B8%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8+%D0%B8+%D0%B1%D0%B5%D0%B7%D0%BE%D0%BF%D0%B0%D1%81%D0%BD%D0%BE%D1%81%D1%82%D1%8C">[[:ru:Проверка подлинности и безопасность]][[ru:Проверка подлинности и безопасность]]
[[:pl:Uwierzytelniania i zabezpieczeń]][[pl:Uwierzytelniania i zabezpieczeń]]
[[:ja:認証とセキュリティ]][[ja:認証とセキュリティ]]
[[:ar:الأمان والمصادقة]][[ar:الأمان والمصادقة]]
[[:zh:身份验证和安全]][[zh:身份验证和安全]]
[[:de:Authentifizierung und Sicherheit]][[de:Authentifizierung und Sicherheit]]
[[:nl:Verificatie en beveiliging]][[nl:Verificatie en beveiliging]]
[[:it:Autenticazione e protezione]][[it:Autenticazione e protezione]]
[[:pt:Autenticação e segurança]][[pt:Autenticação e segurança]]
[[:es:Autenticación y seguridad]][[es:Autenticación y seguridad]]
[[:en:Authentication and security]][[en:Authentication and security]]


==Introduction==
Comment s'authentifier à l'API Ikoula et les politiques de {{Template:Sécurité}} ?

==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 peut être, soit fourni en texte clair (paramètre '''password'''), soit 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 (voir la procédure de génération de la signature ==> [[Génération_de_la_signature|Génération de la signature]]).
 
'''Ces paramètres doivent toujours être passés en GET à l'API !'''
 ATTENTION : 
Le passage du mot de passe en texte clair est fourni pour faciliter la prise en main de l'API et fait office de debug. Pour vos tests de l'API, vous pouvez, par exemple, utiliser un utilisateur temporaire dédié à ces tests et vous authentifier avec son mot de passe en clair (voir le Wiki ci-après pour la création de sous-utilisateur: https://support.ikoula.com/index-1-2-2835.html). 
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 : 
* Contacter notre support pour la création d'un utilisateur extranet ;
* 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: https://support.ikoula.com/index-1-2-2835.html).
Attention à ne pas oublier '''de lui mettre les droits sur les prestations souhaitées'''.
 
;La clé publique de chiffrement du mot de passe est disponible à l'adresse suivante:
: https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem

==Exemples==
Pour cet exemple, le login sera "ikoulasupport". 
Pour crypter le mot de passe, voici un exemple de fonction utilisant la clé publique {{Template:IKoula}} : 
<syntaxhighlight lang="php">
// Chemin local vers la clef publique téléchargée à http://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de cryptage du mot de passe via la clef publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clef publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupére la clef public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// Si il n'y a pas eu d'erreur lors de la récupération de la clef publique on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clef publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur la clée public n'est pas présente.\n");
return NULL;
}
}

// Utilisation de la fonction de cryptage
$password_crypt = opensslEncryptPublic("Mot de passe non crypté");
if($password_crypt != NULL)
echo "OK Mot de passe crypté: ".$password_crypt;
else
echo "Erreur lors du cryptage du mot de passe.";

// ==> $password_crypt contient donc le mot de passe crypté
</syntaxhighlight>

==Conclusion==
Une fois le mot de passe crypté et la signature cryptée, on peut donc faire l'appel API avec comme paramètres (si on suit l'exemple ci-dessus) : 
* login = ikoulasupport ;
* crypted_password = base64_encode($password_crypt) ;
* signature = signature générée (voir la procédure de génération de la signature ==> [[Génération_de_la_signature|Génération de la signature]]).
 
'''NB : N'oubliez pas d'url_encoder chaque paramètre passé !'''


 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]


 
<comments />

Authentification et sécurité

2016-10-19T09:38:35Z

Mschmit52a93 :

[[:he:אבטחה ואימות]][[he:אבטחה ואימות]]
[[:ro:Autentificare și securitate]][[ro:Autentificare și securitate]]
<span data-link_translate_ru_title="Проверка подлинности и безопасность" data-link_translate_ru_url="%D0%9F%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0+%D0%BF%D0%BE%D0%B4%D0%BB%D0%B8%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8+%D0%B8+%D0%B1%D0%B5%D0%B7%D0%BE%D0%BF%D0%B0%D1%81%D0%BD%D0%BE%D1%81%D1%82%D1%8C">[[:ru:Проверка подлинности и безопасность]][[ru:Проверка подлинности и безопасность]]
[[:pl:Uwierzytelniania i zabezpieczeń]][[pl:Uwierzytelniania i zabezpieczeń]]
[[:ja:認証とセキュリティ]][[ja:認証とセキュリティ]]
[[:ar:الأمان والمصادقة]][[ar:الأمان والمصادقة]]
[[:zh:身份验证和安全]][[zh:身份验证和安全]]
[[:de:Authentifizierung und Sicherheit]][[de:Authentifizierung und Sicherheit]]
[[:nl:Verificatie en beveiliging]][[nl:Verificatie en beveiliging]]
[[:it:Autenticazione e protezione]][[it:Autenticazione e protezione]]
[[:pt:Autenticação e segurança]][[pt:Autenticação e segurança]]
[[:es:Autenticación y seguridad]][[es:Autenticación y seguridad]]
[[:en:Authentication and security]][[en:Authentication and security]]


==Introduction== 
Comment s'authentifier à l'API Ikoula et les politiques de {{Template:Sécurité}} ?

==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 peut être, soit fourni en texte clair (paramètre '''password'''), soit 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 (voir la procédure de génération de la signature ==> [[Génération_de_la_signature|Génération de la signature]]).
 
'''Ces paramètres doivent toujours être passés en GET à l'API !'''
 ATTENTION : 
Le passage du mot de passe en texte clair est fourni pour faciliter la prise en main de l'API et fait office de debug. Pour vos tests de l'API, vous pouvez, par exemple, utiliser un utilisateur temporaire dédié à ces tests et vous authentifier avec son mot de passe en clair (voir le Wiki ci-après pour la création de sous-utilisateur: https://support.ikoula.com/index-1-2-2835.html). 
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 : 
* Contacter notre support pour la création d'un utilisateur extranet ;
* 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: https://support.ikoula.com/index-1-2-2835.html).
Attention à ne pas oublier '''de lui mettre les droits sur les prestations souhaitées'''.
 
;La clé publique de chiffrement du mot de passe est disponible à l'adresse suivante:
: https://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem

==Exemples== 
Pour cet exemple, le login sera "ikoulasupport". 
Pour crypter le mot de passe, voici un exemple de fonction utilisant la clé publique {{Template:IKoula}} : 
<syntaxhighlight lang="php">
// Chemin local vers la clef publique téléchargée à http://api.ikoula.com/downloads/Ikoula.API.RSAKeyPub.pem
define('API_PUB_KEY_PATH', dirname(__FILE__) . '/Ikoula.API.RSAKeyPub.pem');

// Fonction de cryptage du mot de passe via la clef publique Ikoula
function opensslEncryptPublic($password)
{
// Vérification de la présence de la clef publique
if(file_exists(API_PUB_KEY_PATH))
{
if(!empty($password))
{
// on récupére la clef public
$publicKey = openssl_pkey_get_public('file://'.realpath(API_PUB_KEY_PATH));

// Si il n'y a pas eu d'erreur lors de la récupération de la clef publique on continue
if ($publicKey !== FALSE)
{
// Si chiffrement clef publique OK
if(openssl_public_encrypt($password, $crypted, $publicKey) === TRUE)
{
// Renvoie du passe crypté
return $crypted;
}
else
{
return NULL;
}
}
else
return NULL;
}
else
return NULL;
}
else
{
echo("Erreur la clée public n'est pas présente.\n");
return NULL;
}
}

// Utilisation de la fonction de cryptage
$password_crypt = opensslEncryptPublic("Mot de passe non crypté");
if($password_crypt != NULL)
echo "OK Mot de passe crypté: ".$password_crypt;
else
echo "Erreur lors du cryptage du mot de passe.";

// ==> $password_crypt contient donc le mot de passe crypté
</syntaxhighlight>

==Conclusion== 
Une fois le mot de passe crypté et la signature cryptée, on peut donc faire l'appel API avec comme paramètres (si on suit l'exemple ci-dessus) : 
* login = ikoulasupport ;
* crypted_password = base64_encode($password_crypt) ;
* signature = signature générée (voir la procédure de génération de la signature ==> [[Génération_de_la_signature|Génération de la signature]]).
 
'''NB : N'oubliez pas d'url_encoder chaque paramètre passé !'''



 
Cet article vous a semblé utile ? <vote />

[[Catégorie:API]]



 
<comments />

Modèle:Domaine

2015-12-04T15:35:20Z

Mschmit52a93 : Page créée avec « [https://express.ikoula.com/fr/nom-de-domaine domaine] »

[https://express.ikoula.com/fr/nom-de-domaine domaine]

Accéder aux vues de CRM grâce à un utilisateur SQL local

2015-10-28T16:25:17Z

Mschmit52a93 : Accéder aux vues de CRM grâce à un utilisateur SQL local

==Introduction== 
Cette article va vous informer sur comment accéder aux vues de CRM (FilteredNameView) en utilisant un compte local sur le serveur SQL.

==Pré-requis== 
Pour pouvoir accéder à ces vues, il vous faut:

* Un utilisateur Active Directory dédié à CRM
* Un compte local sur SQL Server dédié à cette tâche
* Un accès au compte Super Administrateur de SQL Server

==Problèmatique== 
CRM bloque l'utilisation des vues si l’utilisateur n'a pas le rôle de lecture, donc l'utilisateur local ne fonctionne pas, ainsi que le compte Super Administrateur du serveur SQL. C'est une sécurité intégrée à CRM. Il faut partie du domaine et être inséré dans CRM.

==Procédure== 
Pour avoir accès aux vues, il faut ajouter une procédure SQL.

Voici la procédure:

<syntaxhighlight lang="sql">
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE PROCEDURE AccessViewCRMLocal
AS
BEGIN
EXEC sp_addrolemember N'CRMReaderRole', N'VOTRE_UTILISATEUR_LOCAL'
DECLARE @uid uniqueidentifier
SELECT @uid = SystemUserId FROM dbo.SystemUserBase WHERE FullName = 'LE_NOM_DU_COMPTE_CRM'
SET CONTEXT_INFO @uid
END
</syntaxhighlight >

Il faut exécuter cette procédure avec le compte Super Administrateur afin qu'elle soit crée sur le serveur SQL de CRM.

==Exemple: Accéder au contenu des vues grâce à PHP== 
Cet exemple va vous permettre d'accéder aux comptes stockés dans CRM via le Framework Yii.

<syntaxhighlight lang="php">
// On stocke la connexion à CRM via le handler de connexion de Yii
$connexionCrm = Yii::app()->db_crm;

// On éxécute la procédure pour avoir accès aux vues
$connexionCrm->createCommand("EXECUTE AccessViewCRMLocal")->execute();

// On récupère les comptes stockés dans CRM
$query = "SELECT accountid, name, address1_addresstypecode, address1_city, address1_line1, address1_line2, address1_line3 FROM FilteredAccount"
$accounts = $connexionCrm->createCommand($query)->queryAll();
</syntaxhighlight >

Vos comptes client sont désormais dans la variable $accounts.

==Conclusion== 
Grâce à cet article, vous pourrez désormais accéder aux vues dans CRM, et ainsi éviter de refaire les jointures faites de base.


 
Cet article vous a semblé utile ? <vote />




<comments />

Accéder à l'API REST de CRM 2015 On-Premise en PHP

2015-10-20T16:05:43Z

Mschmit52a93 : Accéder à l'API REST de CRM 2015 On-Premise en PHP

==Introduction== 
Cette article va vous permettre d’accéder à l'API REST de CRM 2015 On-Premise avec le langage PHP. Il faut que votre CRM soit relié avec Active DIrectory et être en possession du nom de votre organisation sur CRM.

==Définir ses variables de travail== 

<syntaxhighlight lang="php">
// CRM Server
define('CRM_SERVER', 'NOM_DU_SERVEUR_CRM');

// CRM Organization
define('CRM_ORG_NAME', 'NOM_DE_LORGANISATION');

// CRM WSDL
define('CRM_WSDL', 'http://'.CRM_SERVER.'/'.CRM_ORG_NAME.'/XRMServices/2011/OrganizationData.svc');

// Active Directory
define('AD_DOMAIN_CONTROLER', "NOM_DU_SERVEUR_AD");
define("NTLM_LOGIN", "User");
define("NTLM_PASSWORD", "password");
</syntaxhighlight>

==Récupérer des informations== 

Sur cette exemple, on va récupérer des informations sur un compte.

<syntaxhighlight lang="php">
// On crée l'URL de l'API REST
$url = CRM_WSDL."/AccountSet(guid'GUID_DU_COMPTE')";

// On initialise notre connexion à l'API
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERPWD, NTLM_LOGIN. ':' . NTLM_PASSWORD);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_NTLM);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
curl_setopt($ch, CURLOPT_FAILONERROR, 0);
curl_setopt($ch, CURLOPT_MAXREDIRS, 100);

// On crée nos headers
$headers = array("Content-Type:application/json; charset=utf-8", "Accept:application/json");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

// On récupère le contenu
$account = curl_exec($ch);
</syntaxhighlight>

Grâce à ceci, vous récupérez votre compte en données JSON.

==Mettre à jour des informations== 

Sur cette exemple, on va mettre à jour l'email sur un compte.

<syntaxhighlight lang="php">
// On crée notre objet à mettre à jour
$account = array();
$account['EMailAddress1'] = "adresse@domain.tld";

// On encode en JSON
$account = json_encode($account);

// On crée l'URL de l'API REST
$url = CRM_WSDL."/AccountSet(guid'GUID_DU_COMPTE')";

// On initialise notre connexion à l'API
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERPWD, NTLM_LOGIN. ':' . NTLM_PASSWORD);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_NTLM);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
curl_setopt($ch, CURLOPT_FAILONERROR, 0);
curl_setopt($ch, CURLOPT_MAXREDIRS, 100);
curl_setopt($ch, CURLOPT_POST, 1);

// On crée nos headers
$headers = array("X-HTTP-Method: MERGE", "Content-Type:application/json; charset=utf-8", "Accept:application/json");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

// On l'envoi via CURL
curl_setopt($ch, CURLOPT_POSTFIELDS, $account);

// On récupère le contenu
$response = curl_exec($ch);
</syntaxhighlight>

==Code de retour de l'API== 

Lors d'une erreur, l'API renvoie un tableau en JSON avec le code d'erreur et l'erreur pour aider lors du debug. Lors d'une mise à jour ou d'une suppression, si tout c'est correctement passé, l'API renvoie une variable égale à NULL.

==Conclusion== 
Grâce à cet article, vous pouvez désormais vous connecter à l'API de CRM 2015 pour y faire de la consultation ou de la modification.



 
Cet article vous a semblé utile ? <vote />




<comments />


[[Catégorie:CRM]]