Beispiele für die Verwendung der API - Versionsgeschichte

Ikbot am 9. Februar 2017 um 15:25 Uhr

2017-02-09T15:25:28Z

Ikbot am 7. Dezember 2015 um 17:23 Uhr

2015-12-07T17:23:11Z

Ikbot am 18. November 2015 um 14:33 Uhr

2015-11-18T14:33:22Z

Ikbot am 18. November 2015 um 14:33 Uhr

2015-11-18T14:33:21Z

Ikbot am 18. November 2015 um 14:33 Uhr

2015-11-18T14:33:20Z

Ikbot am 18. November 2015 um 14:33 Uhr

2015-11-18T14:33:19Z

Ikbot am 29. Oktober 2015 um 16:20 Uhr

2015-10-29T16:20:13Z

Ikbot am 29. Oktober 2015 um 16:20 Uhr

2015-10-29T16:20:12Z

Ikbot am 5. Oktober 2015 um 08:44 Uhr

2015-10-05T08:44:37Z

Ikbot: Die Seite wurde neu angelegt: „
Dieser Artikel wurde maschinell übersetzt. Sie können den Artikel Quelle hier ansehen.

2015-10-05T08:44:31Z

Die Seite wurde neu angelegt: „ Dieser Artikel wurde maschinell übersetzt. Sie können den Artikel Quelle hier ansehen. 

Dieser Artikel wurde maschinell übersetzt. Sie können den Artikel Quelle [[:fr:Exemples d'utilisation de l'API|hier]] ansehen. 

[[:fr::nl:Voorbeelden van het gebruik van de APIch]][[:fr:nl:Voorbeelden van het gebruik van de APIch]]
[[:fr::it:Esempi di utilizzo dell'APIch]][[:fr:it:Esempi di utilizzo dell'APIch]]
[[:fr::pt:Exemplos de como usar a APIch]][[:fr:pt:Exemplos de como usar a APIch]]
[[:fr::es:Ejemplos de uso de la APIch]][[:fr:es:Ejemplos de uso de la APIch]]
[[:fr::en:Examples of using the APIch]][[:fr:en:Examples of using the APIch]]



==Einführung == 
Verwendung die API durch Beispiele konkreter und funktionell.

==Funktionen für die Beispiele == 
<syntaxhighlight lang="php">
// Chemin local vers la clé publique téléchargée sur http://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>

==API-Aufrufe == 
<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

</syntaxhighlight>

==Häufige Fehler == 
;Berechtigung verweigert
: Bedeutet, dass der Benutzer in der API verwendet nicht das Recht auf Zugriff auf die angeforderten Informationen oder die gewünschte Aktion
;Passwort entschlüsseln
: Bedeutet, dass den Parameter '''Crypted_password ''' schlecht verschlüsselt oder beschädigt
;Ungültiger Anmeldeinformationen
: Bedeutet, dass die Authentifizierung fehlgeschlagen ist, und also, dass der Benutzer nicht erkannt
;Ungültige oder fehlende Signatur
: Bedeutet, dass die Signatur nicht in den Parametern erhielt von der API vorhanden ist, oder dass es ungültig ist
 Andere Anlagen der Störungen sind möglich aber werden kontextbezogene je nach gewünschter Funktionalität.



 
Dieser Artikel erschien Sie nützlich ? <vote />

[[Category:API]]



 
<comments />