GeoIP2 dotnet

GeoIP2 .NET API

Описание

Этот дистрибутив предоставляет API для веб-сервисов и баз данных GeoIP2 и GeoLite2.

Установка

NuGet

Мы рекомендуем установить эту библиотеку с помощью NuGet. Для этого введите следующее в консоль диспетчера пакетов Visual Studio:

 install-package MaxMind.GeoIP2

Использование IP-геолокации

Геолокация IP по своей сути является неточной. Места часто находятся недалеко от центра населенного пункта. Любое местоположение, предоставленное базой данных GeoIP2 или веб-сервисом, не должно использоваться для идентификации конкретного адреса или домохозяйства.

Использование веб-сервиса

Чтобы использовать API веб-службы, сначала создайте новый объект WebServiceClient с идентификатором вашей учетной записи и лицензионным ключом:

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

Чтобы запросить веб-сервис GeoLite2, вы должны установить хост geolite.info :

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

Чтобы запросить веб-сервис Sandbox GeoIP2, вы должны установить хост sandbox.maxmind.com :

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

Вы также можете указать резервные локали, хост или время ожидания в качестве необязательных параметров. Дополнительную информацию см. в документации API.

Этот объект можно безопасно использовать в разных потоках. Если вы делаете несколько запросов, объект следует использовать повторно, чтобы для каждого запроса не создавались новые соединения. После того как вы закончите делать запросы, вам следует избавиться от объекта, чтобы обеспечить закрытие соединений и быстрый возврат всех ресурсов в систему.

Затем вы можете вызвать метод синхронизации или асинхронности, соответствующий конкретной конечной точке, передав ему IP-адрес, который вы хотите найти, или без параметров, если вы хотите найти текущее устройство.

Если запрос успешен, вызов метода вернет класс ответа для вызываемой вами конечной точки. Этот ответ, в свою очередь, содержит несколько классов моделей, каждый из которых представляет часть данных, возвращаемых веб-службой.

Дополнительную информацию см. в документации API.

Использование ядра ASP.NET

Чтобы использовать API веб-службы с фабричным шаблоном HttpClient в качестве типизированного клиента, вам необходимо сделать следующее:

1. Добавьте следующие строки в метод 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. Добавьте конфигурацию в свой appsettings.json , указав идентификатор своей учетной записи и лицензионный ключ.

...
  "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. Вставьте WebServiceClient туда, где вам нужно выполнить вызов, и используйте его.

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

Пример веб-сервиса

Служба страны (синхронизация)

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

Страновая служба (асинхронная)

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

Сервис Сити Плюс (Синхронизация)

 // 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 (асинхронная)

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

Служба аналитики (синхронизация)

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

Служба аналитики (асинхронная)

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

Использование базы данных

Чтобы использовать API базы данных, вам необходимо создать новый DatabaseReader со строковым представлением пути к вашей базе данных GeoIP2. Вы также можете указать режим доступа к файлу. Затем вы можете вызвать соответствующий метод (например, city ) для вашей базы данных, передав ему IP-адрес, который вы хотите найти.

Если поиск удался, вызов метода вернет класс ответа для поиска GeoIP2. Этот класс, в свою очередь, содержит несколько классов моделей, каждый из которых представляет часть данных, возвращаемых базой данных.

Мы рекомендуем повторно использовать объект DatabaseReader , а не создавать новый для каждого поиска. Создание этого объекта является относительно дорогостоящим, поскольку он должен считывать метаданные файла.

Дополнительную информацию см. в документации API.

Примеры баз данных

Анонимная база данных IP

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

АСН

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

База данных городов

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

База данных типа соединения

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

База данных доменов

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

База данных предприятия

 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
}

База данных интернет-провайдеров

 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