邮编查询

商品介绍

把邮编解析为地点（名称、行政区划、坐标）；未知邮编返回 found 为 false。法国一个邮编可能对应多个市镇。 ## 数据源 请求中的 `provider` 从以下数据源中选择： - `geo-api-gouv` (fr) ## 调用与计费 - 调用 ID（`invocation_id`）由市场网关写入，请求中无需携带，携带的值会被替换。 - 只有服务返回执行成功（`data.execution.outcome` 为 `succeeded`）的调用按一次请求计费；参数错误、数据源失败和结果未知的调用不计费。 - 服务在 `data.execution.usage.units` 中报告用量，单位为 `places`。

价格

以上为公开标价。你的组织可能有协议价，以控制台显示的价格为准。

档位

档位

zgiservices · standard

档位标识

zgi-postal-code-standard

接口协议

HTTP 接口

如何使用

1. 1

   为组织开通

   在控制台为组织开通此商品。开通后即可调用，不需要你自己的厂商账号。

2. 2

   创建凭证

   在控制台“凭证”中创建一个凭证。密钥只显示一次，请保存到环境变量 ZGI_MARKET_KEY，并在每次请求中携带：

   Authorization: Bearer $ZGI_MARKET_KEY

   也可以使用 X-API-Key 请求头。一份凭证可以调用组织已开通的所有商品。

3. 3

   调用网关

   沿用厂商原有的请求与响应格式，只需把 Base URL 和密钥换成下面的值。

   Base URL

   https://market-api.zgi.im/v1/gateway/zgi-postal-code-standard

   curl -X POST "https://market-api.zgi.im/v1/gateway/zgi-postal-code-standard/v1/postal-code-lookups" \
     -H "Authorization: Bearer $ZGI_MARKET_KEY" \
     -H "Content-Type: application/json" \
     -d '{}'

   入参与输出

   各操作的入参和输出结构，以 JSON Schema 描述。

   POST /v1/postal-code-lookups

   {
     "type": "object",
     "required": [
       "provider",
       "country",
       "postal_code"
     ],
     "properties": {
       "country": {
         "type": "string",
         "description": "ISO 3166-1 alpha-2 country code: GB for postcodes-io, FR for geo-api-gouv."
       },
       "provider": {
         "enum": [
           "geo-api-gouv"
         ],
         "type": "string",
         "description": "Provider that serves the request; choose by the coverage described for this tool."
       },
       "postal_code": {
         "type": "string",
         "description": "Postal code, 2-10 characters of A-Z, 0-9, space or hyphen, for example SW1A 1AA or 75001."
       }
     },
     "additionalProperties": false
   }

   {
     "type": "object",
     "required": [
       "code",
       "data"
     ],
     "properties": {
       "code": {
         "type": "integer"
       },
       "data": {
         "type": "object",
         "required": [
           "execution",
           "result"
         ],
         "properties": {
           "result": {
             "type": "object",
             "required": [
               "found",
               "places",
               "source"
             ],
             "properties": {
               "found": {
                 "type": "boolean"
               },
               "places": {
                 "type": [
                   "array",
                   "null"
                 ],
                 "items": {
                   "type": "object",
                   "required": [
                     "postal_code",
                     "place_name",
                     "admin_area_1",
                     "admin_area_2",
                     "latitude",
                     "longitude",
                     "country"
                   ],
                   "properties": {
                     "country": {
                       "type": "string"
                     },
                     "latitude": {
                       "type": [
                         "number",
                         "null"
                       ]
                     },
                     "longitude": {
                       "type": [
                         "number",
                         "null"
                       ]
                     },
                     "place_name": {
                       "type": "string"
                     },
                     "postal_code": {
                       "type": "string"
                     },
                     "admin_area_1": {
                       "type": [
                         "string",
                         "null"
                       ]
                     },
                     "admin_area_2": {
                       "type": [
                         "string",
                         "null"
                       ]
                     }
                   }
                 }
               },
               "source": {
                 "type": "object",
                 "required": [
                   "name",
                   "license",
                   "url"
                 ],
                 "properties": {
                   "url": {
                     "type": "string"
                   },
                   "name": {
                     "type": "string"
                   },
                   "license": {
                     "type": "string"
                   }
                 }
               }
             }
           },
           "execution": {
             "type": "object",
             "description": "The recorded execution: id, invocation_id, outcome, usage, and timing."
           }
         }
       },
       "message": {
         "type": "string"
       }
     }
   }

来源与审核

审核状态

未记录

来源文档

https://services.zgi.im/capabilities/postal-code/

许可证

未说明

审核状态是平台对上架信息的记录，不构成对上游服务质量或可用性的担保。