API仕様：GET /api/v1/check/area/{zipcode}/{key}-{key}...

  1. トップ

GET https://api-zipcode.jp/api/v1/check/area/{郵便番号}/{検索条件キー}-{検索条件キー}...

概要

郵便番号が特定のエリアに含まれるかをboolで判定します。
例えば、163-8001が渋谷区と港区以外の東京都23区内の郵便番号か？を判定できます。
答えは都庁の郵便番号で新宿区なのでtrueとなります。

消費ポイント

3 ポイント

Authentication

APIトークン必要

Headers

key type value
Authorization string Bearer <YOUR_API_TOKEN_HERE> required
Content-type string application/json required
Accept string application/json required

Request Parameters

key type value
{郵便番号} number 郵便番号（7桁） required
{検索条件キー...} string 検索条件キーを" + "か" - "で繋いで条件を指定します。
あらかじめ、アカウントの検索条件ページで条件を作成します。
検索条件を作成すると、8桁のキーが発行されます。
このキーを" + "か" - "で連結することで細かく条件を指定します。
例えば"東京都23区" - "新宿区"と指定すると、郵便番号が新宿区以外の23区かを判定できます。
また、"東京都23区" + "武蔵野市" - "渋谷区" - "港区"のような判定も可能です。 		required

Responses JSON

key value
ステータスコード
  • 200 : OK（成功）
  • 401 : Unauthenticated. （トークンが無いか無効です）
  • 402 : There are not enough points. （ポイントが足りません）
  • 403 : Invalid ability provided. （トークンにアビリティがありません）
  • 422 : Unprocessable Entity. （リクエストが無効です）
  • 429 : Too Many Attempts. （レートリミッター発動）
  • 503 : Service Unavailable. （サーバーメンテナンス中です）

エクスプローラー

＊
＊

あらかじめ、アカウントの検索条件ページで条件を作成してください。