InsuranceSuite Cloud API

InsuranceSuite Cloud API は、RESTful システム API のセットです。呼び出し元アプリケーションはこれを使用して、InsuranceSuite アプリケーションにデータを要求したりその中でアクションを開始できます。これらの API により REST API フレームワークのコンテンツ（すべての InsuranceSuite アプリケーション内に存在）を渡します。これらの API は、Swagger 2.0 仕様を使用して作成されています。これらは、システム API とも呼ばれます。

システム API は、ブラウザベースのアプリケーションおよびサービス間アプリケーションから使用できます。このドキュメントでは、システム API を呼び出すアプリケーションやサービスを示すために、一般的に、呼び出し元アプリケーションという用語を使います。

システム API 呼び出しの実行

以下の図は、呼び出し元アプリケーションとシステム API との間におけるやり取りの概要を示しています。

呼び出し元アプリケーションが、要求オブジェクトを作成します。要求オブジェクトは、以下のもので構成されています。
- ヘッダー（認証情報およびその他のメタデータを含めることができます）
- ペイロード（必要な場合）
呼び出し元アプリケーションが HTTP コマンドを使用してシステム API に要求を送信します。
- コマンドは、特定の API エンドポイントを呼び出します。
- コマンドにはさらに、目的のデータを特定するクエリパラメータが含まれる場合があります。
- 要求オブジェクトはコマンドとともに送信されます。
システム API が要求を処理します。
- このアクティビティでは、すべての InsuranceSuite アプリケーションロジック（検証ロジックや更新前ルールなど）が使用されます。
- 要求は、システム API 内の権限制御によって制限されます。
システム API が、HTTP 応答コード（成功した場合の 200 など）および応答オブジェクトを送信して応答します。応答オブジェクトは、以下のもので構成されています。
- ヘッダー
- ペイロード（必要な場合）

システム API と InsuranceSuite のロジック

ソフトウェア業界では、一部の RESTful API は、データベースと直接やり取りするようにコンフィギュレーションされます。システム API は、このような動作をするようにはコンフィギュレーションされていません。システム API は、アプリケーションのビジネスロジックの層を通してのみ運用データとやり取りします。したがって、システム API では常に、アプリケーションの既存ビジネスロジックを活用します。

次に例を示します。

アクティビティを作成する権限を持っていない内部ユーザーがいるとします。内部ユーザーがシステム API でアクティビティを作成しようとすると、権限不足エラーになります。
アクティビティの期日を将来の日付に設定することを求める検証ルールがあるとします。外部システムが期日を過去の日付に設定してアクティビティを作成しようとすると、検証エラーになります。
ドキュメントが「最終」とマークされるたびに承認アクティビティを作成する更新前ルールがあるとします。外部システムがシステム API で「最終」ドキュメントを作成すると、更新前ルールによって承認アクティビティで作成されます。