GeoIP2 dotnet

GeoIP2 .NET-API

Beschreibung

Diese Distribution stellt eine API für die Webdienste und Datenbanken GeoIP2 und GeoLite2 bereit.

Installation

NuGet

Wir empfehlen, diese Bibliothek mit NuGet zu installieren. Geben Sie dazu Folgendes in die Visual Studio Package Manager-Konsole ein:

 install-package MaxMind.GeoIP2

IP-Geolocation-Nutzung

Die IP-Geolokalisierung ist von Natur aus ungenau. Standorte liegen oft in der Nähe des Bevölkerungszentrums. Jeder Standort, der von einer GeoIP2-Datenbank oder einem Webdienst bereitgestellt wird, sollte nicht zur Identifizierung einer bestimmten Adresse oder eines bestimmten Haushalts verwendet werden.

Nutzung von Webdiensten

Um die Webdienst-API zu verwenden, erstellen Sie zunächst ein neues WebServiceClient Objekt mit Ihrer Konto-ID und Ihrem Lizenzschlüssel:

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

Um den GeoLite2-Webdienst abzufragen, müssen Sie den Host auf geolite.info setzen:

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

Um den Sandbox GeoIP2-Webdienst abzufragen, müssen Sie den Host auf sandbox.maxmind.com einstellen:

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

Sie können auch die Fallback-Gebietsschemas, den Host oder das Timeout als optionale Parameter angeben. Weitere Informationen finden Sie in den API-Dokumenten.

Dieses Objekt kann sicher über Threads hinweg geteilt werden. Wenn Sie mehrere Anfragen stellen, sollte das Objekt wiederverwendet werden, damit nicht für jede Anfrage neue Verbindungen erstellt werden. Sobald Sie alle Anfragen gestellt haben, sollten Sie das Objekt entsorgen, um sicherzustellen, dass die Verbindungen geschlossen werden und alle Ressourcen umgehend an das System zurückgegeben werden.

Sie können dann die Sync- oder Async-Methode aufrufen, die dem spezifischen Endpunkt entspricht, und ihr die IP-Adresse übergeben, nach der Sie suchen möchten, oder keine Parameter, wenn Sie das aktuelle Gerät suchen möchten.

Wenn die Anfrage erfolgreich ist, gibt der Methodenaufruf eine Antwortklasse für den von Ihnen aufgerufenen Endpunkt zurück. Diese Antwort wiederum enthält mehrere Modellklassen, von denen jede einen Teil der vom Webdienst zurückgegebenen Daten darstellt.

Weitere Einzelheiten finden Sie in der API-Dokumentation.

ASP.NET Core-Nutzung

Um die Webdienst-API mit dem HttpClient-Factory-Muster als typisierten Client zu verwenden, müssen Sie Folgendes tun:

1. Fügen Sie der Startup.cs -Methode ConfigureServices die folgenden Zeilen hinzu:

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

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

2. Fügen Sie die Konfiguration in Ihrer appsettings.json mit Ihrer Konto-ID und Ihrem Lizenzschlüssel hinzu.

...
  "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. Fügen Sie den WebServiceClient dort ein, wo Sie den Anruf tätigen müssen, und verwenden Sie ihn.

 [ 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 ;
    }
} 

Beispiel für einen Webdienst

Länderdienst (Synchronisierung)

 // 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 " ] ) ; // '美国'
}

Länderdienst (asynchron)

 // 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 " ] ) ; // '美国'
}

City Plus-Dienst (Synchronisierung)

 // 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
}

City Plus-Dienst (asynchron)

 // 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
}

Insights-Dienst (Synchronisierung)

 // 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
}

Insights-Dienst (asynchron)

 // 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
} 

Datenbanknutzung

Um die Datenbank-API verwenden zu können, müssen Sie einen neuen DatabaseReader mit einer Zeichenfolgendarstellung des Pfads zu Ihrer GeoIP2-Datenbank erstellen. Sie können auch den Dateizugriffsmodus festlegen. Anschließend können Sie die entsprechende Methode (z. B. city ) für Ihre Datenbank aufrufen und ihr die IP-Adresse übergeben, nach der Sie suchen möchten.

Wenn die Suche erfolgreich ist, gibt der Methodenaufruf eine Antwortklasse für die GeoIP2-Suche zurück. Diese Klasse wiederum enthält mehrere Modellklassen, von denen jede einen Teil der von der Datenbank zurückgegebenen Daten darstellt.

Wir empfehlen, das DatabaseReader -Objekt wiederzuverwenden, anstatt für jede Suche ein neues zu erstellen. Die Erstellung dieses Objekts ist relativ aufwändig, da Metadaten für die Datei eingelesen werden müssen.

Weitere Einzelheiten finden Sie in der API-Dokumentation.

Datenbankbeispiele

Anonyme IP-Datenbank

 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'
}

Stadtdatenbank

 // 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
}

Datenbank vom Verbindungstyp

 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'
}

Domänendatenbank

 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'
}

Unternehmensdatenbank

 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
}

ISP-Datenbank

 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