GeoIP2 dotnet

API GeoIP2 .NET

Description

Cette distribution fournit une API pour les services Web et bases de données GeoIP2 et GeoLite2.

Installation

NuGet

Nous vous recommandons d'installer cette bibliothèque avec NuGet. Pour ce faire, tapez ce qui suit dans la console Visual Studio Package Manager :

 install-package MaxMind.GeoIP2

Utilisation de la géolocalisation IP

La géolocalisation IP est par nature imprécise. Les emplacements sont souvent proches du centre de la population. Tout emplacement fourni par une base de données GeoIP2 ou un service Web ne doit pas être utilisé pour identifier une adresse ou un foyer particulier.

Utilisation des services Web

Pour utiliser l'API du service Web, créez d'abord un nouvel objet WebServiceClient avec votre ID de compte et votre clé de licence :

 var client = new WebServiceClient(42, "license_key1");

Pour interroger le service web GeoLite2, vous devez définir l'hôte sur geolite.info :

 var client = new WebServiceClient(42, "license_key1", host: "geolite.info");

Pour interroger le service Web Sandbox GeoIP2, vous devez définir l'hôte sur sandbox.maxmind.com :

 var client = new WebServiceClient(42, "license_key1", host: "sandbox.maxmind.com");

Vous pouvez également spécifier les paramètres régionaux de secours, l'hôte ou le délai d'attente comme paramètres facultatifs. Consultez la documentation de l'API pour plus d'informations.

Cet objet peut être partagé en toute sécurité entre les threads. Si vous effectuez plusieurs requêtes, l'objet doit être réutilisé afin que de nouvelles connexions ne soient pas créées pour chaque requête. Une fois que vous avez fini de faire des demandes, vous devez vous débarrasser de l'objet pour vous assurer que les connexions sont fermées et que toutes les ressources sont rapidement renvoyées au système.

Vous pouvez ensuite appeler la méthode de synchronisation ou asynchrone correspondant au point final spécifique, en lui transmettant l'adresse IP que vous souhaitez rechercher ou aucun paramètre si vous souhaitez rechercher l'appareil actuel.

Si la requête réussit, l’appel de méthode renverra une classe de réponse pour le point de terminaison que vous avez appelé. Cette réponse contient à son tour plusieurs classes de modèles, chacune représentant une partie des données renvoyées par le service Web.

Consultez la documentation de l'API pour plus de détails.

Utilisation du noyau ASP.NET

Pour utiliser l'API du service Web avec le modèle de fabrique HttpClient en tant que client typé, vous devez procéder comme suit :

1. Ajoutez les lignes suivantes à la méthode Startup.cs ConfigureServices :

 // Configure to read configuration options from MaxMind section
services . Configure < WebServiceClientOptions > ( Configuration . GetSection ( " MaxMind " ) ) ;

// Configure dependency injection for WebServiceClient
services . AddHttpClient < WebServiceClient > ( ) ;

2. Ajoutez la configuration dans votre appsettings.json avec votre identifiant de compte et votre clé de licence.

...
  "MaxMind" : {
    "AccountId" : 123456 ,
    "LicenseKey" : "1234567890" ,

    // Optionally set a timeout. The default is 3000 ms.
    // "Timeout": 3000,

    // Optionally set host. "geolite.info" will use the GeoLite2
    // web service instead of GeoIP2. "sandbox.maxmind.com" will use the
    // Sandbox GeoIP2 web service instead of the production GeoIP2 web
    // service.
    //
    // "Host": "geolite.info"
  } ,
...

3. Injectez le WebServiceClient à l'endroit où vous devez passer l'appel et utilisez-le.

 [ ApiController ]
[ Route ( " [controller] " ) ]
public class MaxMindController : ControllerBase
{
    private readonly WebServiceClient _maxMindClient ;

    public MaxMindController ( WebServiceClient maxMindClient )
    {
        _maxMindClient = maxMindClient ;
    }

    [ HttpGet ]
    public async Task < string > Get ( )
    {
        var location = await _maxMindClient . CountryAsync ( ) ;

        return location . Country . Name ;
    }
} 

Exemple de service Web

Service pays (synchronisation)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. Set the named host argument to "geolite.info" to use the GeoLite2
// web service instead of GeoIP2. Set the named host argument to
// "sandbox.maxmind.com" to use the Sandbox GeoIP2 web service instead of
// the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = client . Country ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'
}

Service national (asynchrone)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. Set the named host argument to "geolite.info" to use the GeoLite2
// web service instead of GeoIP2. Set the named host argument to
// "sandbox.maxmind.com" to use the Sandbox GeoIP2 web service instead of
// the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = await client . CountryAsync ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'
}

Service City Plus (synchronisation)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. Set the named host argument to "geolite.info" to use the GeoLite2
// web service instead of GeoIP2. Set the named host argument to
// "sandbox.maxmind.com" to use the Sandbox GeoIP2 web service instead of
// the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = client . City ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'

    Console . WriteLine ( response . MostSpecificSubdivision . Name ) ;    // 'Minnesota'
    Console . WriteLine ( response . MostSpecificSubdivision . IsoCode ) ; // 'MN'

    Console . WriteLine ( response . City . Name ) ; // 'Minneapolis'

    Console . WriteLine ( response . Postal . Code ) ; // '55455'

    Console . WriteLine ( response . Location . Latitude ) ;  // 44.9733
    Console . WriteLine ( response . Location . Longitude ) ; // -93.2323
}

Service City Plus (asynchrone)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. Set the named host argument to "geolite.info" to use the GeoLite2
// web service instead of GeoIP2. Set the named host argument to
// "sandbox.maxmind.com" to use the Sandbox GeoIP2 web service instead of
// the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = await client . CityAsync ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'

    Console . WriteLine ( response . MostSpecificSubdivision . Name ) ;    // 'Minnesota'
    Console . WriteLine ( response . MostSpecificSubdivision . IsoCode ) ; // 'MN'

    Console . WriteLine ( response . City . Name ) ; // 'Minneapolis'

    Console . WriteLine ( response . Postal . Code ) ; // '55455'

    Console . WriteLine ( response . Location . Latitude ) ;  // 44.9733
    Console . WriteLine ( response . Location . Longitude ) ; // -93.2323
}

Service Insights (synchronisation)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. The GeoLite2 web service does not support Insights. Set the named
// host argument to "sandbox.maxmind.com" to use the Sandbox GeoIP2 web
// service instead of the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = client . Insights ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'

    Console . WriteLine ( response . MostSpecificSubdivision . Name ) ;    // 'Minnesota'
    Console . WriteLine ( response . MostSpecificSubdivision . IsoCode ) ; // 'MN'

    Console . WriteLine ( response . City . Name ) ; // 'Minneapolis'

    Console . WriteLine ( response . Postal . Code ) ; // '55455'

    Console . WriteLine ( response . Location . Latitude ) ;  // 44.9733
    Console . WriteLine ( response . Location . Longitude ) ; // -93.2323
}

Service d'informations (asynchrone)

 // If you are making multiple requests, a single WebServiceClient
// should be shared across requests to allow connection reuse. The
// class is thread safe.
//
// Replace "42" with your account ID and "license_key" with your license
// key. The GeoLite2 web service does not support Insights. Set the named
// host argument to "sandbox.maxmind.com" to use the Sandbox GeoIP2 web
// service instead of the production GeoIP2 web service.
using ( var client = new WebServiceClient ( 42 , " license_key " ) )
{
    // Do the lookup
    var response = await client . InsightsAsync ( " 128.101.101.101 " ) ;

    Console . WriteLine ( response . Country . IsoCode ) ;        // 'US'
    Console . WriteLine ( response . Country . Name ) ;           // 'United States'
    Console . WriteLine ( response . Country . Names [ " zh-CN " ] ) ; // '美国'

    Console . WriteLine ( response . MostSpecificSubdivision . Name ) ;    // 'Minnesota'
    Console . WriteLine ( response . MostSpecificSubdivision . IsoCode ) ; // 'MN'

    Console . WriteLine ( response . City . Name ) ; // 'Minneapolis'

    Console . WriteLine ( response . Postal . Code ) ; // '55455'

    Console . WriteLine ( response . Location . Latitude ) ;  // 44.9733
    Console . WriteLine ( response . Location . Longitude ) ; // -93.2323
} 

Utilisation de la base de données

Pour utiliser l'API de base de données, vous devez créer un nouveau DatabaseReader avec une représentation sous forme de chaîne du chemin d'accès à votre base de données GeoIP2. Vous pouvez également spécifier le mode d'accès au fichier. Vous pouvez ensuite appeler la méthode appropriée (par exemple, city ) pour votre base de données, en lui transmettant l'adresse IP que vous souhaitez rechercher.

Si la recherche réussit, l'appel de méthode renverra une classe de réponse pour la recherche GeoIP2. Cette classe contient à son tour plusieurs classes de modèles, chacune représentant une partie des données renvoyées par la base de données.

Nous vous recommandons de réutiliser l'objet DatabaseReader plutôt que d'en créer un nouveau pour chaque recherche. La création de cet objet est relativement coûteuse car il faut lire les métadonnées du fichier.

Consultez la documentation de l'API pour plus de détails.

Exemples de bases de données

Base de données IP anonyme

 using ( var reader = new DatabaseReader ( " GeoIP2-Anonymous-IP.mmdb " ) )
{
    var response = reader . AnonymousIP ( " 85.25.43.84 " ) ;
    Console . WriteLine ( response . IsAnonymous ) ;        // true
    Console . WriteLine ( response . IsAnonymousVpn ) ;     // false
    Console . WriteLine ( response . IsHostingProvider ) ;  // false
    Console . WriteLine ( response . IsPublicProxy ) ;      // false
    Console . WriteLine ( response . IsResidentialProxy ) ; // false
    Console . WriteLine ( response . IsTorExitNode ) ;      // true
    Console . WriteLine ( response . IPAddress ) ;          // '85.25.43.84'
}

ASN

 using ( var reader = new DatabaseReader ( " GeoLite2-ASN.mmdb " ) )
{
    var response = reader . Asn ( " 85.25.43.84 " ) ;
    Console . WriteLine ( response . AutonomousSystemNumber ) ; // 217
    Console . WriteLine ( response . AutonomousSystemOrganization ) ; // 'University of Minnesota'
    Console . WriteLine ( response . IPAddress ) ; // '128.101.101.101'
}

Base de données de la ville

 // This creates the DatabaseReader object, which should be reused across
// lookups.
using ( var reader = new DatabaseReader ( " GeoIP2-City.mmdb " ) )
{
    // Replace "City" with the appropriate method for your database, e.g.,
    // "Country".
    var city = reader . City ( " 128.101.101.101 " ) ;

    Console . WriteLine ( city . Country . IsoCode ) ; // 'US'
    Console . WriteLine ( city . Country . Name ) ; // 'United States'
    Console . WriteLine ( city . Country . Names [ " zh-CN " ] ) ; // '美国'

    Console . WriteLine ( city . MostSpecificSubdivision . Name ) ; // 'Minnesota'
    Console . WriteLine ( city . MostSpecificSubdivision . IsoCode ) ; // 'MN'

    Console . WriteLine ( city . City . Name ) ; // 'Minneapolis'

    Console . WriteLine ( city . Postal . Code ) ; // '55455'

    Console . WriteLine ( city . Location . Latitude ) ; // 44.9733
    Console . WriteLine ( city . Location . Longitude ) ; // -93.2323
}

Base de données de type connexion

 using ( var reader = new DatabaseReader ( " GeoIP2-Connection-Type.mmdb " ) )
{
    var response = reader . ConnectionType ( " 128.101.101.101 " ) ;
    Console . WriteLine ( response . ConnectionType ) ; // 'Corporate'
    Console . WriteLine ( response . IPAddress ) ; // '128.101.101.101'
}

Base de données de domaine

 using ( var reader = new DatabaseReader ( " GeoIP2-Domain.mmdb " ) )
{
    var response = reader . Domain ( " 128.101.101.101 " ) ;
    Console . WriteLine ( response . Domain ) ; // 'umn.edu'
    Console . WriteLine ( response . IPAddress ) ; // '128.101.101.101'
}

Base de données d'entreprise

 using ( var reader = new DatabaseReader ( " /path/to/GeoIP2-Enterprise.mmdb " ) )
{
    //  Use the Enterprise(ip) method to do a lookup in the Enterprise database
    var response = reader . enterprise ( " 128.101.101.101 " ) ;

    var country = response . Country ;
    Console . WriteLine ( country . IsoCode ) ;            // 'US'
    Console . WriteLine ( country . Name ) ;               // 'United States'
    Console . WriteLine ( country . Names [ " zh-CN " ] ) ;     // '美国'
    Console . WriteLine ( country . Confidence ) ;         // 99

    var subdivision = response . MostSpecificSubdivision ;
    Console . WriteLine ( subdivision . Name ) ;           // 'Minnesota'
    Console . WriteLine ( subdivision . IsoCode ) ;        // 'MN'
    Console . WriteLine ( subdivision . Confidence ) ;     // 77

    var city = response . City ;
    Console . WriteLine ( city . Name ) ;       // 'Minneapolis'
    Console . WriteLine ( city . Confidence ) ; // 11

    var postal = response . Postal ;
    Console . WriteLine ( postal . Code ) ; // '55455'
    Console . WriteLine ( postal . Confidence ) ; // 5

    var location = response . Location ;
    Console . WriteLine ( location . Latitude ) ;       // 44.9733
    Console . WriteLine ( location . Longitude ) ;      // -93.2323
    Console . WriteLine ( location . AccuracyRadius ) ; // 50
}

Base de données des FAI

 using ( var reader = new DatabaseReader ( " GeoIP2-ISP.mmdb " ) )
{
    var response = reader . Isp ( " 128.101.101.101 " ) ;
    Console . WriteLine ( response . AutonomousSystemNumber ) ; // 217
    Console . WriteLine ( response . AutonomousSystemOrganization ) ; // 'University of Minnesota'
    Console . WriteLine ( response . Isp ) ; // 'University of Minnesota'
    Console . WriteLine ( response . Organization