Fonctionnement

Bienvenue sur notre documentation d'API, pour commencer à utiliser l'API il faut vous rendre dans votre espace client et générer une API_KEY (Clé d'API).

Code couleur des réponses :

Success

Warning

Error

Besoin d'aide ? Prenez contact avec notre équipe ici

Exemple de code (PHP et conservation du tableau JSON)

<?PHP

//Appel de l'API
$return = file_get_contents('https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=state&vps={SERVICE_NAME}');

//Vous allez recevoir une réponse de ce style : {"state":"poweredOn","cpu_percent":"2","memory_percent":"75","uptime":"01:00:46","lastboot":"2018-04-15 20:52:33"}

//Décoder la réponse
$json = json_decode($return);

//Afficher les éléments de la réponse (Cela affichera la valeur de : state)
echo $json->{'state'};

* Ce code peut bien sur être modifié selon vos besoins.

Exemple de code (PHP et conversion du tableau JSON en tableau PHP)

<?PHP

//Appel de l'API
$return = file_get_contents('https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=state&vps={SERVICE_NAME}');

//Vous allez recevoir une réponse de ce style : {"state":"poweredOn","cpu_percent":"2","memory_percent":"75","uptime":"01:00:46","lastboot":"2018-04-15 20:52:33"}

//Décoder la réponse
$json = json_decode($return, true);

//Afficher les éléments de la réponse (Cela affichera la valeur de : state)
echo $json['state'];

* Ce code peut bien sur être modifié selon vos besoins.

API /VPS

Démarrer un VPS

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=boot&vps={SERVICE_NAME}

Réponse (return):

success : Démarrage réussi
failed : Démarrage échoué
error : Erreur

Exemple :

																						{"return":"success"}

Redémarrer un VPS

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=reboot&vps={SERVICE_NAME}

Réponse (return):

success : Redémarrage réussi
failed : Redémarrage échoué
error : Erreur

Exemple :

																						{"return":"success"}

Arrêter un VPS

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=stop&vps={SERVICE_NAME}

Réponse (return):

success : Arrêt réussi
failed : Arrêt échoué
error : Erreur

Exemple :

																						{"return":"success"}

Connaitre l'état d'un VPS

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=state&vps={SERVICE_NAME}

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (state):

poweredOn : VPS allumé
poweredOff : VPS éteint

Réponse (cpu_percent):

0 - 100 : Pourcentage utilisé de CPU

Réponse (memory_percent):

0 - 100 : Pourcentage utilisé de mémoire

Réponse (uptime):

00:00:00 : Temps écoulé depuis le dernier boot

Réponse (lastboot):

0000-00-00 00:00:00 : Date du dernier boot

Exemple :

																						{"return":"success","state":"poweredOn","cpu_percent":"2","memory_percent":"75","uptime":"01:00:46","lastboot":"2018-04-15 20:52:33"}

Liste des sytèmes d'exploitation disponible

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=os

Réponse (return):

success : Requête réussi
error : Erreur

Exemple :

																						{"debian7":"Debian 7","ws2012":"Windows Server 2012","debian8":"Debian 8"}

Réinstaller un VPS

https://api.cloudfordream.com/api/vps.php?api_key={API_KEY}&action=reset&vps={SERVICE_NAME}&os={OS_ID}

Réponse (return):

success : Reset réussi
failed : Reset échoué
error : Erreur

Réponse (os):

ws2012 : Os en cours d'installation

Exemple :

																						{"return":"success","os":"ws2012"}

API /WEB

Générer un nouveau mot de passe Plesk

https://api.cloudfordream.com/api/web.php?api_key={API_KEY}&action=newPass&web={SERVICE_NAME}

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (service):

web_xxxxxxxxxxxx : Nom du service

Réponse (new_password):

xxxxxxxx : Nouveau mot de passe du compte Plesk

Exemple :

																						{"return":"success","service":"web_5b58f77894b67","new_password":"nRR0qgWk"}

Avoir les informations Plesk & FTP

https://api.cloudfordream.com/api/web.php?api_key={API_KEY}&action=getInfo&web={SERVICE_NAME}

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (plesk):

https://plesk03.cloudfordream.com:8443 : Lien du panel Plesk

Réponse (plesk_login):

web_xxxxxxxxxxxxx : Login Plesk

Réponse (plesk_password):

xxxxxxxxxxx : Mot de passe Plesk

Réponse (ftp_host):

0.0.0.0 : IP pour la connexion FTP

Réponse (ftp_login):

apidemo : Login pour la connexion FTP

Réponse (ftp_password):

xxxxxxxxxxx : Mot de passe pour la connexion FTP

Exemple :

																						{"return":"success","plesk":"https://plesk03.cloudfordream.com:8443","plesk_login":"web_5bae78fc999z1","plesk_password":"zTx497kZF3","ftp_host":"0.0.0.0","ftp_login":"apidemo","ftp_password":"AR42dc5x6A"}

API /SERVICE

Liste des services

https://api.cloudfordream.com/api/service.php?api_key={API_KEY}&action=list

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (service):

Tableau des ID de vos services

Exemple :

																						{"return":"success","service":["165","200","211","245","326","295"]}

Détails d'un service

https://api.cloudfordream.com/api/service.php?api_key={API_KEY}&action=detail&serviceId={SERVICE_ID}

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (service_name):

Nom du service

Réponse (description):

Description du service

Réponse (create_date):

2017-05-04 00:00:00 : Date de création du service

Réponse (expire_date):

2019-06-04 00:00:00 : Date d'expiration du service

Réponse (state):

ACTIVE : Activé
BLOCKED : Bloqué
DISABLED : Désactivé
EXPIRED : Expiré
INSTALL_PROCESS : Première installation en cours
REINSTALL : En cours de réinstallation
DDOS : Suspendu pour DDoS
NOT_INSTALLED : Première installation non-effectué

Réponse (auto_renew):

1 / 0 : Renouvellement automatique activé ou non

Exemple :

																						{"return":"success","service_name":"user_0470","description":"MySQL Test","create_date":"2017-05-04 00:00:00","expire_date":"2019-06-04 00:00:00","state":"ACTIVE","auto_renew":"0"}

Activer ou désactiver le renouvellement automatique

https://api.cloudfordream.com/api/service.php?api_key={API_KEY}&action=autoRenew&serviceId={SERVICE_ID}

Réponse (return):

success : Requête réussi
error : Erreur

Réponse (expire_date):

2019-06-04 00:00:00 : Date d'expiration du service

Réponse (auto_renew):

1 / 0 : Renouvellement automatique activé ou non

Exemple :

																						{"return":"success","expire_date":"2019-07-26 00:20:02","state":"ACTIVE","auto_renew":"1"}