GeoIP2 dotnet

GeoIP2 .NET API

คำอธิบาย

การแจกจ่ายนี้จัดเตรียม API สำหรับบริการเว็บและฐานข้อมูล GeoIP2 และ GeoLite2

การติดตั้ง

นูเก็ต

เราขอแนะนำให้ติดตั้งไลบรารีนี้ด้วย NuGet เมื่อต้องการทำเช่นนี้ ให้พิมพ์สิ่งต่อไปนี้ลงในคอนโซล Visual Studio Package Manager:

 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 สำหรับข้อมูลเพิ่มเติม

วัตถุนี้มีความปลอดภัยในการแชร์ข้ามเธรด หากคุณกำลังส่งคำขอหลายรายการ ควรนำออบเจ็กต์นั้นกลับมาใช้ใหม่เพื่อไม่ให้สร้างการเชื่อมต่อใหม่สำหรับแต่ละคำขอ เมื่อคุณส่งคำขอเสร็จแล้ว คุณควรกำจัดออบเจ็กต์เพื่อให้แน่ใจว่าการเชื่อมต่อถูกปิด และทรัพยากรใดๆ จะถูกส่งกลับไปยังระบบทันที

จากนั้นคุณอาจเรียกใช้เมธอด sync หรือ async ที่สอดคล้องกับจุดสิ้นสุดที่ระบุ โดยส่งที่อยู่ 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 " ] ) ; // '美国'
}

บริการประเทศ (Async)

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

ซิตี้พลัส เซอร์วิส (Async)

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

บริการข้อมูลเชิงลึก (Async)

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

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

ฐานข้อมูลเมือง

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