Webservice listant les régions Françaises
>
Services JSON > Liste régions Françaises
Fonctionnement haut de page
Ce service permet de récupérer la liste des régions Françaises 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 :
: String (nom que vous avez donné à votre application)
: String (la clé que vous avez reçu lors de la création de votre application)
Arguments optionnels haut de page
: 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/fr/region?login=APP_LOGIN&apikey=APP_KEY&callback=1
Réponse haut de page
Les informations sont retournées au format JSON.
: String (retourne le nom de la région)
: Integer (numéro de la région)
Exemple de réponse retournée par ce service SANS le paramètre "callback" :
{"results":[
{"rg":"Alsace", "code": 42},
{"rg":"Aquitaine", "code": 72},
{"rg":"Auvergne", "code": 83},
{"rg":"Basse-Normandie", "code": 25},
{"rg":"Bourgogne", "code": 26},
...
{"rg":"Rhône-Alpes", "code": 82}
]}
Exemple de réponse retournée par ce service AVEC le paramètre "callback" :
jsonCallback({"results":[
{"rg":"Alsace", "code": 42},
{"rg":"Aquitaine", "code": 72},
{"rg":"Auvergne", "code": 83},
{"rg":"Basse-Normandie", "code": 25},
{"rg":"Bourgogne", "code": 26},
...
{"rg":"Rhône-Alpes", "code": 82}
]})
Liste des exempleshaut de page
Exemple d'appel en Javascripthaut de page
Cet exemple présente une méthode pour appeler la liste des régions Françaises 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 régions Françaises */
function appelAjax() {
var method='GET';
...
var api_name= "...";
var api_key = "...";
var url = "https://www.citysearch-api.com/fr/region?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;
...
}
}
Exemple d'appel en PHPhaut de page
Cet exemple présente une méthode pour appeler la liste des régions à partir du serveur PHP appelant l'API.
Cet exemple est associé à une mise en cache du résultat pendant 60 secondes.
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é aux régions Françaises $match = $dir."/region.json";
$exist = true;
$api_key = "...";
$api_name = "...";
//-- si le fichier n'existe pas on le créé
if(!file_exists($dir."/region.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/region?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->rg ." : ". $result->code;
echo "
";
}
}else {
echo "Aucun résultat trouvé.";
}
Afficher les commentaires | Signaler une erreur
L'URL complète se compose sous la forme suivante :
https://www.citysearch-api.com/fr/region?login=APP_LOGIN&apikey=APP_KEY