サンプル概要#
サンプルWebアプリを実際に動作させ、APIをコールするまでの流れを記載します。
サンプルWebアプリは、Java言語＋Webアプリケーションサーバーで動作するように作成されています。
また、本サンプルWebアプリはAPI使用方法を確認する為に提供しております。
ダウンロードしたzipファイルを基にした環境構築方法はこちらを参照してください。
サンプルWebアプリケーションダウンロード
サンプル画面全体図#
サンプルで使用しているAPI一覧#
サンプルで用意されている画面は全部で１５種類あり、顧客の登録・変更・削除・検索、グループの登録・変更・削除・検索などのAPIが呼び出されます。
APIの詳細についてはリファレンスを参照してください。
| No | API | 処理内容 | 使用用途 |
|---|---|---|---|
| 1 | GET /API/v2/api/customers | 顧客を検索する | 顧客一覧画面で入力情報をもとに顧客情報を検索 顧客変更画面で顧客IDを基に顧客情報を検索 グループ編集画面でグループIDを条件にグループに属している顧客を検索 |
| 2 | GET /API/v2/api/customerslistcount | 顧客の件数を取得する | 顧客一覧画面でページングを行う際、事前に検索対象の件数を把握 |
| 3 | POST /API/v2/api/customers | 顧客を登録する | 顧客登録画面で登録ボタン押下時に顧客情報を作成 |
| 4 | PUT /API/v2/api/customers/{customer_id} | 顧客を変更する | 顧客変更画面で変更ボタン押下時に顧客情報を変更 |
| 5 | DELETE /API/v2/api/customers/{customer_id} | 顧客を削除する | 顧客変更画面で削除ボタン押下時に顧客情報を削除 |
| 6 | GET /API/v2/api/basiccontract | 基本契約を検索する | 基本契約一覧画面で入力情報をもとに基本契約情報を検索 基本契約変更画面で基本契約IDを基に基本契約情報を検索 |
| 7 | POST /API/v2/api/basiccontract | 基本契約を編集する | 基本契約登録画面で登録ボタン押下時に基本契約情報を作成 基本契約変更画面で変更ボタン押下時に基本契約情報を変更 基本契約変更画面で削除ボタン押下時に基本契約情報を削除 |
| 8 | GET /API/v2/api/basiccontractlistcount | 基本契約の件数を取得する | 基本契約一覧画面でページングを行う際、事前に検索対象の件数を把握 |
| 9 | POST /API/v2/api/servicepricemaster | サービス料金情報を編集する | サービス登録画面で登録ボタン押下時にサービス料金情報を作成 サービス変更画面で変更ボタン押下時にサービス料金情報を変更 サービス変更画面で削除ボタン押下時にサービス料金情報を削除 |
| 10 | GET /API/v2/api/servicepricemaster | サービス料金情報を検索する | サービス一覧画面で入力情報をもとにサービス料金情報を検索 サービス契約登録画面でプルダウンの内容を表示 サービス変更画面で「サービス詳細画面」からの引数を基にサービス料金情報を検索 |
| 11 | GET /API/v2/api/services | サービスマスタを検索する | サービス契約登録画面でプルダウンの内容を表示 |
| 12 | GET /API/v2/api/servicecontracts | サービス契約を検索する | サービス契約一覧画面で前画面より引き継がれた情報をもとにサービス契約情報を検索 サービス契約変更画面でサービス契約IDを基にサービス契約情報を検索 |
| 13 | GET /API/v2/api/servicecontractslistcount | サービス契約の件数を取得する | 前画面より受け渡された情報を基にサービス契約情報の件数を検索 |
| 14 | POST /API/v2/api/servicecontracts | サービス契約を編集する | サービス契約登録画面で登録ボタン押下時にサービス契約情報を作成 サービス契約変更画面で変更ボタン押下時にサービス契約情報を変更 サービス契約変更画面で削除ボタン押下時にサービス契約情報を削除 |
| 15 | GET /API/v2/api/group | グループを検索する | グループ一覧画面で入力情報をもとにグループ情報を検索 グループ編集画面でグループIDを条件にグループ情報を検索 顧客一覧画面・基本契約登録画面・基本契約変更画面でプルダウンの内容を表示 |
| 16 | GET /API/v2/api/grouplistcount | グループの件数を取得する | グループ一覧画面でページングを行う際、事前に検索対象の件数を把握 |
| 17 | POST /API/v2/api/group | グループを作成する | グループ登録画面で登録ボタン押下時にグループ情報を作成 |
| 18 | PUT /API/v2/api/group/{group_id} | グループを変更する | グループ編集画面で変更ボタン押下時にグループ情報を変更 |
| 19 | DELETE /API/v2/api/group/{group_id} | グループを削除する | グループ編集画面で削除ボタン押下時にグループ情報を削除 |
| 20 | POST /API/v2/api/grouprelation | グループに紐づく顧客を追加する | グループ登録画面・グループ編集画面でグループに紐づく顧客を登録 |
| 21 | DELETE /API/v2/api/grouprelation | グループに紐づく顧客を削除する | グループ登録画面でグループに紐づく顧客を削除 |
機能実装方法#
実際にサンプルを見ながらAPIをどのようにして使用するかを解説します。
顧客情報検索実装編#
顧客情報を検索するAPIのサンプルを解説します。
顧客情報登録実装編#
顧客情報を登録するAPIのサンプルを解説します。
顧客情報変更実装編#
顧客情報を変更するAPIのサンプルを解説します。
顧客情報削除実装編#
顧客情報を削除するAPIのサンプルを解説します。
基本契約情報検索実装編#
基本契約情報を検索するAPIのサンプルを解説します。
基本契約情報登録実装編#
基本契約情報を登録するAPIのサンプルを解説します。
基本契約情報変更実装編#
基本契約情報を変更するAPIのサンプルを解説します。
基本契約情報削除実装編#
基本契約情報を削除するAPIのサンプルを解説します。
サービス契約情報検索実装編#
サービス契約情報を検索するAPIのサンプルを解説します。
サービス契約情報登録実装編#
サービス契約情報を登録するAPIのサンプルを解説します。
サービス契約情報変更実装編#
サービス契約情報を変更するAPIのサンプルを解説します。
サービス契約情報削除実装編#
サービス契約情報を削除するAPIのサンプルを解説します。
グループ情報検索実装編#
グループ情報を検索するAPIのサンプルを解説します。
グループ情報登録実装編#
グループ情報を登録するAPIとグループに紐づく顧客を追加するAPIのサンプルを解説します。
グループ情報変更実装編#
グループ情報を変更するAPIとグループに紐づく顧客を追加するAPI、グループに紐づく顧客を削除するAPIのサンプルを解説します。
グループ情報削除実装編#
グループ情報を削除するAPIのサンプルを解説します。
サービス情報検索実装編#
サービス情報を検索するAPIのサンプルを解説します。
サービス情報登録実装編#
サービス情報を登録するAPIのサンプルを解説します。
サービス情報変更実装編#
サービス情報を変更するAPIのサンプルを解説します。
サービス情報削除実装編#
サービス情報を削除するAPIのサンプルを解説します。