邮编信息 0.2.2

身份验证

您需要一个 身份验证令牌（auth token）。如果您使用MOJ DS的Postcode Info服务器，可以通过发送电子邮件至 platforms@digital.justice.gov.uk 并简要说明

• 您的身份

• 您打算使用它的项目

• 您预计每天将进行多少次查找

如果您正在运行自己的服务器，请参阅 https://github.com/ministryofjustice/postcodeinfo#auth_tokens 了解创建令牌的说明。

快速入门

在您的代码中

>>> import postcodeinfo

>>> # create a client
>>> client = postcodeinfo.Client("YOUR-ACCESS-TOKEN")

>>> # lookup a postcode
>>> postcode = client.lookup_postcode("SW1A 1AA")

>>> # postcode details
>>> postcode.valid
True

>>> postcode.latitude
51.50100893654096

>>> postcode.longitude
-0.141587558526369

>>> postcode.local_authority
{
    'gss_code': 'E09000033',
    'name': 'Westminster'
}

>>> postcode.country
{
    "name": "England",
    "gss_code": "E92000001"
}

>>> postcode.addresses
[
    {
        "uprn": "10033544614",
        "organisation_name": "BUCKINGHAM PALACE",
        "department_name": "",
        "po_box_number": "",
        "building_name": "",
        "sub_building_name": "",
        "building_number": None,
        "thoroughfare_name": "",
        "dependent_thoroughfare_name": "",
        "dependent_locality": "",
        "double_dependent_locality": "",
        "post_town": "LONDON",
        "postcode": "SW1A 1AA",
        "postcode_type": "L",
        "formatted_address": "Buckingham Palace\nLondon\nSW1A 1AA",
        "point": {
            "type": "Point",
            "coordinates": [
                -0.141587558526369,
                51.50100893654096
            ]
        }
    }
]

显式 api_url

您可以通过将其传递给 Client 构造函数来显式设置 api_url

# create a client
client = postcodeinfo.Client("YOUR-API-TOKEN", api_url="https://some.dom.ain")

或者在现有的客户端上设置它，如下所示

client = postcodeinfo.Client("YOUR-API-TOKEN")
client.api_url = "https://some.dom.ain"

隐式 api_url

如果您没有将 api_url 传递给构造函数，它将尝试从环境中推断一个。客户端具有内置的环境名称到URL的映射。

>>> postcodeinfo.Client.api_urls
{
    'development': 'http://localhost:8000',
    'test': 'http://localhost:8000',
    'staging': 'https://postcodeinfo-staging.dsd.io',
    'production': 'https://postcodeinfo.service.justice.gov.uk'
}

它将使用以下规则来推断URL

1. 如果您将 env 参数传递给构造函数（例如：client = postcodeinfo.Client("YOUR-API-TOKEN", env="staging")），它将使用该参数作为 api_urls 映射的参考。

2. 如果您在环境中设置了 DJANGO_SETTINGS_MODULE，它将尝试在该模块中找到以下设置

   POSTCODEINFO_API_URL
   POSTCODEINFO_API_TOKEN
   POSTCODEINFO_API_TIMEOUT

3. 否则它将默认为 development