「外部API連携（ボタン）」はスタンダードプラン以上の機能です。
こんなお困りごとはありませんか？
- 住所を手入力するのに時間がかかる。
- 郵便番号と住所の記入が一致せず、入力ミスにつながる。
- 誤った住所で申請され、差し戻しや確認の手間が発生する。
実現したいこと
外部API連携ボタンを使うと、申請者が「郵便番号」を入力してボタンを押すだけで、都道府県・市区町村・町域をフォームへ自動入力できます。
メリット
- 住所を手入力する手間を省けます。
- 郵便番号と住所の入力ミスや不一致を防げます。
- 誤った住所による差し戻しや確認の手間を減らせます。
注意
本設定例では、外部サービス『 zipcloud 郵便番号検索API』（外部サイト）を利用します。
zipcloudはkickflowが提供するサービスではありません。
サービスの仕様変更や提供停止、レスポンス内容の正確性については保証されないため、利用にあたってはお客様自身の判断と責任のもとでご確認ください。
最新の利用条件は『 zipcloud 郵便番号検索API』（外部サイト）でご確認ください。
また、外部API連携（ボタン）では、URLのクエリパラメータやBodyに指定した値が、そのまま外部サービス側へ送信されます。
本設定例では、郵便番号フィールドの値のみが送信されますが、フィールドの参照を誤ると、意図しない項目の値が外部サービス側に送信される場合があります。
変数名の指定に誤りがないか必ず確認してください。
設定手順
1. 郵便番号を入力するフィールドを作成する
- 「管理センター」＞「ワークフロー」＞「ワークフロー」を開き、対象のワークフローで新しいバージョンを作成します。
- 「フィールドを追加」をクリックし、「基本設定」タブの「型」で「テキスト（短文）」を選択し、フィールド名を「郵便番号」にします。
- 作成したフィールドの「変数名」タブを開き、変数名を確認します。本記事では、この変数名が
zipcodeである前提で説明します。
変数は、項目の配置順が上のものから順次評価されます。他のフィールドの変数名と部分一致していると、意図しない値でリクエストされる場合があります。例えば $zip と $zipcode のように、一方がもう一方を含む変数名を使う場合は注意してください。
2. 住所取得ボタンのフィールドを作成する
-
「フィールドを追加」をクリックし、「基本設定」タブの「型」で「外部API連携（ボタン）」を選択し、フィールド名を「住所取得ボタン」にします。
-
「外部API連携（ボタン）設定」タブを開き、「リクエスト設定」を以下のように入力します。
項目 設定値 HTTPメソッド GET URL https://zipcloud.ibsnet.co.jp/api/search?zipcode=$zipcode$zipcodeの部分は、手順1で確認した郵便番号フィールドの変数名に置き換えてください。
-
続けて「レスポンス設定」を以下のように入力します。
項目 設定値 レスポンスの形式 複数レコード データの配列を抽出するJSONPath $.results
-
「フィールドへのマッピング設定」で、以下の3行を追加します。
フィールド 値のJSONPath 選択用テーブルで表示 選択用テーブルでのタイトル 住所1 $.address1チェック 住所1 住所2 $.address2チェック 住所2 住所3 $.address3チェック 住所3 
JSONPathの書き方は 外部API連携ボタンにおけるJSONPathの書き方について教えてください を参照してください。
3. 住所を格納するフィールドを作成する
「住所1」「住所2」「住所3」にあたるテキスト（短文）のフィールドを作成します。手順2の「フィールドへのマッピング設定」で選んだフィールドと対応させてください。
4. ワークフローを保存する
そのまま画面を進み、ワークフローを保存します。
動作確認
- 実際のチケット作成画面で「郵便番号」に検索したい郵便番号を入力します。
- 住所取得ボタンの「実行」を押します。
- 選択用のダイアログが表示され、申請者が該当する住所を選ぶと「住所1」「住所2」「住所3」にそれぞれ自動で転記されます。
うまく動作しないときは
- 変数名が他のフィールドの変数名と部分一致していないか確認してください。
- 郵便番号にハイフンを含めて入力した場合の挙動は、『 zipcloud 郵便番号検索API』（外部サイト）の仕様でご確認ください。