検索条件をリクエストボディで指定できるPOSTエンドポイントを追加しました

平素よりケンオールをご利用いただきまして誠にありがとうございます。

このたび、住所→郵便番号APIおよび法人番号APIの検索について、検索条件をクエリ文字列ではなくリクエストボディで指定できるPOSTエンドポイントの提供を開始しました。

検索機能・レスポンス構造・料金・プラン条件・リクエスト回数の制限はすべてGETと同一で、ご利用いただけるキーの種類も同じです (公開キー・シークレットキーのいずれでも利用可)。同じ検索条件であれば、GETとPOSTは同一のレスポンスを返します。

用途この見出しへのリンク

検索した住所や検索語をURLに残したくない場合にお使いください。

URLはアクセスログのほか、ブラウザの履歴・Referer ヘッダ・お客様側のフォワードプロキシなど、弊社では制御できない箇所にも記録されることがあります。検索条件をリクエストボディに入れていただくことで、これらに検索内容が残らなくなります。

仕様の要点この見出しへのリンク

• 検索条件はすべてリクエストボディに入れます。フィールド名と意味はGETのクエリパラメータと同じです。
• version (データのバージョン指定) のみ、バッチAPIと同様にクエリ文字列で指定します。
• Content-Type は application/json と application/x-www-form-urlencoded に対応しています。
• 空の値の扱いが2形式で異なります。詳細は各リファレンスの該当セクションをご参照ください。

# 住所→郵便番号API (JSON)
curl -X POST -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"t": "東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F", "limit": 1}' \
  "https://api.kenall.jp/v1/postalcode/"
 
# 法人番号API (フォーム形式)
curl -X POST -H "Authorization: Token YOUR_API_KEY" \
  --data-urlencode "q=オープンコレクター AND _facet_area:/東京都" \
  --data-urlencode "limit=3" \
  "https://api.kenall.jp/v1/houjinbangou"

ご対応のお願いこの見出しへのリンク

お客様によるお手続きは必要ありません。従来のGETエンドポイントは変更なく、引き続きご利用いただけます。POSTエンドポイントは、必要に応じて任意でお使いいただける追加の選択肢です。

詳細この見出しへのリンク

各APIのリファレンスをご参照ください。

• 住所→郵便番号API リファレンス: POST /v1/postalcode/
• 法人番号API リファレンス: POST /v1/houjinbangou

お問い合わせこの見出しへのリンク

本件に関するご質問は お問い合わせフォーム よりご連絡ください。