この章では、外部システムとのAPI連携について説明します。
情報を登録する際に外部の情報を参照・引用したいと思ったことはありませんか？
外部API連携機能を利用することで、外部のサービスを利用した情報の検索や値の取得をすることができます。
目次
外部API連携でできること
外部API連携の機能は、アクション部品を利用して外部サービスの情報を取得し、バインダ内の他部品に格納することができます。
■イメージ動画
今回は住所検索APIを利用して、郵便番号の入力で住所が自動検索・入力される例で説明していきます。
外部API連携機能を利用し、「郵便番号検索サービス」を利用します。SmartDB上で郵便番号を入力し、API実行ボタンをクリックすることで検索結果が自動入力されます。
※下の図の▶をクリックしてアニメーションでイメージを確認してください。
実際に設定してみよう
アクション部品を追加し、「入力した郵便番号に該当する住所を検索、値を自動入力」するように設定していきます。
■設定動画
| 住所検索リクエストのURL https://api.zipaddress.net/?zipcode=$contents.get( 部品ID ).value └住所検索リクエスト └検索したい住所の郵便番号は 部品ID の値 |
設定の手順
- フォーム定義編集画面を開く
- API実行ボタンを設置したい場所に部品を追加する
- 部品タイプ「アクション部品」を選択する
- 項目名、表示したい説明文など適宜設定する
- タイプで「外部API連携」を選択する
- API実行ボタンに表示させるボタン名を記載する
- 外部サービスにリクエストする内容を記載する
- 外部サービスで返されたレスポンスを、部品に値反映させる設定をします
- 入力先の部品・抽出方法を選択し、入力したいデータのパスを記載する
- 設定した内容をフォーム定義で保存する
API連携のポイント
各サービスのAPIを使用することで、ご紹介した郵便番号での住所検索以外の様々な外部サービスを利用できます。
活用例：経路検索・マスタデータの参照・法人情報検索・名刺情報検索など
※サービスにより、アカウントの登録が必要な場合があります。
※今回の動画では「郵便番号-住所検索API」を利用させていただいています。弊社では、こちらのAPIの推奨・サポートはしておりません。
※その他、他社が提供するAPIに関しまして、弊社で推奨・サポートしているものではございません。
まとめ
- 外部API連携機能を利用すると、外部のサービスをSmartDB上で利用することができる
- アクション部品を設定し、取得した外部サービスの値を他部品に自動入力させることができる
- 様々なサービスを利用できるが、サービスによりAPI利用にはアカウント登録が必要
関連情報
- 外部システム連携ガイド
└連携方法 >外部API連携