2.6.2 リクエスト設計

項目		値		備考
APIエンドポイント (相対URI)		/CBConversion/api/v1/convert
クエリパラメーター	address	必須	住所文字列	400文字以内上記を超過する文字列は変換できませんその他の仕様については“2.6.7 注意事項”を参照
	select	任意	どの値を取得するかレスポンスフォーマットにおけるJSON値のキー名を複数指定することが可能です。また、“all”を指定することですべての住所情報を取得可能です	カスタマバーコードのみ(customer_barcode)の取得がデフォルト複数指定する場合は、,(カンマ)で区切ります例）select=customer_barcode,postal
	auto_correct	任意	住所自動補正フラグ	住所文字列を自動補正して処理するかどうかを指定します誤字、脱字などの補正を自動的に行います(1文字誤りまで補正可能) “0”:住所の自動補正を行わない（デフォルト） “1”：住所の自動補正を行う
HTTPメソッド		GET

例)

curl -i -s http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/CBConversion/api/v1/convert?auto_correct=1 --get --data-urlencode 'address=港区新橋1-5-2 汐留シティセンター' --data-urlencode 'select=postal,customer_barcode'

注)インベントリファイルのapi_tomcat_portに設定した値を指定

参照

Apahe Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2 リクエスト設計

2.6.2.1 リクエストフォーマット