Webservices JSON | Webservices XML | communes proches |

Webservice listant les pays

Fonctionnement haut de page

Ce service permet de récupérer la liste des pays au format JSON.

Arguments requis haut de page

Les paramètres requis sont le login (APP_LOGIN) et la clé (APP_KEY) que vous avez créés pour le site concerné, tel que :

apikey: String (la clé que vous avez reçu lors de la création de votre application)

L'URL complète se compose sous la forme suivante :

https://www.citysearch-api.com/fr/pays?login=APP_LOGIN&apikey=APP_KEY

Arguments optionnels haut de page

callback: integer ( inclusion du json dans l'élément "jsonCallback()" ).

Prend les valeurs suivantes :

"1" : inclu le json dans l'élément "jsonCallback()", utile par exemple pour les requêtes via JSONP de jQuery, voir l'exemple.

Exemple d'URL avec le paramètre callback :

https://www.citysearch-api.com/ch/pays?login=APP_LOGIN&apikey=APP_KEY&callback=1

Réponse haut de page

Les informations sont retournées au format JSON.

pays: String (retourne le nom du pays)

code: Integer (Code ISO 3166-1 du pays)

Exemple de réponse retournée par ce service SANS le paramètre "callback" :

	{"results":[
		{"pays":"Afghanistan","code": "AF"},
		...
		{"pays":"Finlande","code":"FI"},
		{"pays":"France","code":"FR"},
		{"pays":"Gabon","code":"GA"},
		{"pays":"Gambie","code":"GM"},
		...
		{"pays":"Zimbabwe","code":"ZW"}
	]}

Exemple de réponse retournée par ce service AVEC le paramètre "callback" :

	jsonCallback({"results":[
		{"pays":"Afghanistan","code": "AF"},
		...
		{"pays":"Finlande","code":"FI"},
		{"pays":"France","code":"FR"},
		{"pays":"Gabon","code":"GA"},
		{"pays":"Gambie","code":"GM"},
		...
		{"pays":"Zimbabwe","code":"ZW"}
	]})

Liste des exempleshaut de page

Exemple d'appel en Javascript Exemple d'appel en PHP

Exemple d'appel en Javascripthaut de page

Cet exemple présente une méthode pour appeler la liste des pays directement depuis le navigateur client via javascript.

Ce exemple ne prend pas en compte l'utilisation de librairies javascript tel que jquery, mootools...

	
	/**
	* Fonction qui va récupérer la liste des pays
	*/
	function appelAjax() {
   		var method='GET';
  		...
  		var api_name=	"...";
  		var api_key	=	"...";
		var url		=	"https://www.citysearch-api.com/fr/pays?login="+api_name+"&apiKey="+api_key";
	   	http.open(method, url);
	   	// Déclaration de la fonction à appeler pour traiter le retour Ajax
	   	http.onreadystatechange = handleResponse;
	   	...	
	
		http.send(null);
		...
	}
	
	/**
	* Fonction qui traitera la réponse AJAX
	*/
	function handleResponse() {
		// Si l'état = 4 ...
		if(http.readyState == 4){
			...
			// On stocke la réponse Ajax dans la variable "response"
			var response = http.responseText;
				
			...
		}
	}

Télécharger l'exemple

Exemple d'appel en PHPhaut de page

Cet exemple présente une méthode pour appeler la liste des pays à partir du serveur PHP appelant l'API.

Cet exemple est associé à une mise en cache du résultat pendant 60 secondes.

A noter : La mise en cache n'est pas obligatoire et n'est présentée qu'à titre de suggestion.

	//-- $dir correspond au dossier dans lequel sera placé le cache
    $dir 		= 	'/cache';
    
    //-- $match correspond au fichier cache dédié à la région
	$match		=	$dir."/pays.json";
	$exist		=	true;
	$api_key	=	"...";
	$api_name	=	"...";
	
	//-- si le fichier n'existe pas on le créé
	if(!file_exists($dir."/pays.json")) {
		$match 	= 	fopen($match, "r");
		$exist	=	false;
	}
	
	//-- on regarde si le cache a expiré et que le fichier ne vient pas juste d'être créé
	if((time()-filemtime($match) < 60) && $exist) {
	    $raw 	= 	file_get_contents($match);
	    $json 	= 	json_decode($raw);
	
	//-- si il a expiré alors on le rappel
	}else {
	    $url 	= 	"https://www.citysearch-api.com/fr/pays?login=".$api_name."&apiKey=".$api_key";	    
	    $raw 	= 	file_get_contents($url);
	    file_put_contents($match, $raw);
	    $json 	= 	json_decode($raw);
	}
	
	//-- on traite le résultat
	if(!empty($json->results)){
        foreach($json->results as $result) {
            echo "" . $result->pays ." : ". $result->code;
            echo "
";
        }
    }else {
        echo "Aucun résultat trouvé.";
    }