Le but de l'Api Ipv4 to Country est de fournir le code pays associé à l'adresse IP. L'architecture de ce service est autonome et léger pour garantir de bonnes performances.
A qui s'adresse l'API ip to Country
En tant que Webmaster, il est utile de connaitre l'origine d'une connexion à son site internet. Le code pays retourné par l'api peut être utiliser dans les cas de figure suivant:statistique: de la même manière que les outils d'analyse de trafic tel que Google Analytics, vous souhaitez connaitre le pays d'origine des visites,
langue: l'utilisation du code pays de l'adresse IP constitue le premier élément pour rediriger les internautes vers un contenu dans leur propre langue,
filtre: lorsque l'on veut bloquer le contenu de rubriques à des proxy ou autre VPN, le code pays constitue un critère fiable.
Comment utiliser l'API de localisation
L'api fonctionne à partir d'une requête de type GET classique, accessible à partir de n'importe quel langage de programmation.L'URL comporte 2 paramètres obligatoire:
key: la clé d'authentification
ip: l'adresse ip au format ipv4 ou ipv6
paramètre optionnel
format: par défaut, l'api utilise le format XML. Le paramètre format=json retourne les données encodées en Json.
lang: langue utilisée pour le nom du pays. Les langues disponibles sont: us (défaut), fr (français), de (allemand), it (italien).
Exemple
Url à saisir pour le code pays de l'adresse ip 8.8.8.8 au format xml et en français.
/api/iptocountry.php?key=api-key&ip=8.8.8.8&format=json&lang=fr
<?xml version="1.0" encoding="UTF-8" ?>
<iptocountry>
<status>200</status>
<ip>8.8.8.8</ip>
<code>US</code>
<name>Etats-Unis</name>
<lang>fr</lang>
<update>02/05/2014</update>
<ref>http://www.fobec.com/apps/localiser-ip/8.8.8.8</ref>
</iptocountry>
Exemple d'appel et d'interprétation en PHP
Le plus souvent, l'api est utilisée de manière automatique avec un langage de programmation. Le service de localisation du pays peut etre utilisée ainsi en PHP.<?php
//Contruire la requete HTML
$api_url='http://www.fobec.com/api/iptocountry.php?';
$key='api-key';
$format='xml';
$lang='fr';
$ipv4='8.8.8.8';
$url=$api_url.'key='.$key.'&format='.$format.'&lang='.$lang.'&ip='.$ipv4;
//Lire le résultat de l'api
$xml = simplexml_load_file($url);
echo '<br/>status: ' . $xml->status;
echo '<br/>ip: ' . $xml->ip;
echo '<br/>code: ' . $xml->code;
echo '<br/>pays: ' . $xml->name;
exit(0);
?>
Gestion des erreurs
Afin de faciliter la mise en place et le contrôle dans vos applications, l'API intègre une gestion des erreurs. Le code de l'erreur est retourné dans la propriété status et le libellé de l'erreur est contenu dans la propriété message.400 Bad Request: la requête est incorrecte, vérifiez les paramètres ip et key
401 Unauthorized : la clé transmise dans le paramètre key est incorrecte
403 Query limit exceeds: le nombre de requêtes autorisé est dépassé
500 Internal Error: une erreur est survenue dans le fonctionnement de l'api.
Obtenir une clé et Feedback
Recevoir un cléEn attendant une procédure automatique, la demande de clé d'authentification devra être faite par email (register-api@nomdedomainedusite), remplacez nomdedomainedusite par Fobec.com
Indiquez dans votre message une adresse email qui servira à générer la clé et à etre informer des mises à jour
Usage et limite de l'API
Aucun garantie n'est fournie pour les données, les valeurs retournée sont retournées à titre indicatif.
L'API est gratuite pour un usage privé et limité à 1000 requêtes par semaine. Aucune reproduction n'est permise quelque soit le support. Pour des volumes plus importants ou pour tout autre usage, veuillez nous contacter.
Demo de l'api
Pour tester le fonctionnement de l'api, une démo est accessible ici demo api ip to country. Changer le paramètre ip pour l'adapter à votre usage.
