Skip to main content
GET
API de géolocalisation IP
L’API fonctionne avec une simplicité remarquable : il suffit de fournir votre clé API ainsi qu’une adresse IP, et vous recevrez des données de localisation complètes incluant les codes postaux, les noms de villes, les informations régionales, les détails du pays et des coordonnées latitude/longitude précises.

Premiers pas

Architecture REST

Comme toutes les API Cleariflow, l’API de géolocalisation IP suit les principes REST. Elle utilise des URL prévisibles, orientées ressources, et des codes de statut HTTP pour indiquer les erreurs.

Sécurité HTTPS

Toutes les communications avec l’API de géolocalisation IP doivent être sécurisées par des protocoles TLS 1.2 ou supérieur.

Versionnage de l’API

Toutes les API Cleariflow intègrent le versionnage. L’API de géolocalisation IP fonctionne actuellement en version 1.

Authentification par clé API

Votre clé API sert d’identifiant d’authentification unique pour accéder à l’API de géolocalisation IP Cleariflow. Il est important de noter que chaque API Cleariflow nécessite une clé API distincte ; vous aurez donc besoin de clés séparées pour différents services comme l’API de géolocalisation IP et l’API de validation d’e-mail. Pour authentifier vos requêtes, ajoutez votre clé API à l’URL de base.

URL de base

Endpoint de géolocalisation

L’API de géolocalisation IP Cleariflow ne requiert que votre clé API unique et détecte automatiquement l’adresse IP du client demandeur. Vous pouvez également inclure le paramètre « ip_address » pour spécifier une IP particulière à analyser :
Il s’agit d’une requête réussie, renvoyant l’adresse IP et les détails associés ci-dessous :

Paramètres de requête

String
requis
Votre clé API unique. Notez que chaque utilisateur possède des clés API uniques pour chaque API Cleariflow ; votre clé de l’API de géolocalisation IP ne fonctionnera pas pour votre API de validation d’e-mail, par exemple.
String
L’adresse IP à géolocaliser. Les adresses IPv4 et IPv6 sont prises en charge. Notez que si vous laissez ce paramètre vide, le service géolocalisera l’adresse IP à partir de laquelle la requête a été effectuée.
String
Liste séparée par des virgules de clés de premier niveau à renvoyer (par exemple, ?fields=country,security). Pour inclure les indicateurs VPN/proxy, utilisez security — l’objet entier est renvoyé (is_vpn, is_proxy et vpn_provider le cas échéant). Les clés imbriquées telles que is_vpn seules ne sont pas prises en charge.

Paramètres de réponse

La réponse de l’API est renvoyée dans un format JSON universel et léger.
String
L’adresse IP soumise pour géolocalisation.
String
Nom de la ville.
String
ID geoname de la ville.
String
État ou province dans lequel la ville est située.
Char[2]
Code ISO 3166-2 de l’État ou de la province.
String
ID geoname de l’État ou de la province.
String
Code postal.
String
Nom du pays.
Char[2]
Code ISO 3166-1 alpha-2 du pays.
String
ID geoname du pays.
Boolean
Vrai si le pays est dans l’UE, faux sinon.
String
Nom du continent.
Char[2]
Code continent à 2 lettres : AF, AS, EU, NA, OC, SA, AN.
String
ID geoname du continent.
Float
Valeur décimale de la longitude.
Float
Valeur décimale de la latitude.
Boolean
true lorsque l’IP correspond à la base de données des nœuds de sortie VPN (IP-to-VPN MMDB).
Boolean
true lorsque l’IP correspond à la base de données proxy (IP-to-VPN MMDB).
String
Nom du service VPN depuis la MMDB (par exemple, NordVPN). Omis lorsque is_vpn est false.
String
Nom du fuseau horaire depuis la base de données IANA Time Zone.
String
Abréviation du fuseau horaire, également depuis la base de données IANA Time Zone.
String
Décalage du fuseau horaire par rapport au temps moyen de Greenwich (GMT).
String
Heure actuelle dans le fuseau horaire local.
Boolean
Vrai si la localisation est actuellement en heure d’été (DST).
String
Lien vers une version hébergée du drapeau du pays au format SVG.
String
Lien vers une version hébergée du drapeau du pays au format PNG.
String
Drapeau du pays sous forme d’emoji.
String
Drapeau du pays en unicode.
String
Nom de la devise.
String
Code de la devise au format ISO 4217.
String
Déduit du nom de l’organisation ASN (par exemple, Cellular, Cable/DSL, Corporate, Cloud, Hosting). VPN et proxy sont signalés dans security, pas ici.
Uint32
Numéro de système autonome.
String
Nom de l’organisation du système autonome.
String
Nom du fournisseur d’accès Internet (FAI).
String
Nom de l’organisation.

Limiter les champs de réponse

Vous pouvez choisir de ne recevoir que quelques champs de la réponse JSON. Pour ce faire, incluez une valeur fields dans les paramètres de requête avec une liste séparée par des virgules des clés de premier niveau que vous souhaitez recevoir. Par exemple, une requête pour obtenir uniquement le pays et la ville d’une IP ressemblera à ceci :
La réponse ressemblerait à ceci :

Cas d’utilisation

Géolocaliser un visiteur de site web

Pour demander la géolocalisation à partir d’une adresse IP, incluez simplement votre clé API unique dans le modèle ci-dessous. Notez que vous n’avez pas besoin de connaître l’IP du visiteur pour effectuer la requête.
C’est tout ce dont vous avez besoin pour obtenir la géolocalisation et d’autres données d’un visiteur ! Il n’y a qu’un seul paramètre requis : votre clé API unique.

Codes de réponse et d’erreur

Lorsqu’une requête échoue pour une raison quelconque, une erreur est également renvoyée au format JSON. Les erreurs comprennent un code d’erreur et une description, que vous trouverez en détail ci-dessous.

Codes pays

Voici une liste des codes pays ISO 3166 Alpha 2 à deux lettres utilisés dans la réponse. Consultez cette liste au format CSV.

Autres notes

Information importante sur la facturation : chaque adresse IP traitée consomme un crédit. La facturation s’effectue par soumission de requête, que la réponse soit réussie ou non. Par conséquent, soumettre une adresse IP invalide comme « fda3346ds » déduira quand même un crédit de votre compte.