Rest API を使用すると、Composer ソリューションを HTTP REST API を使用して他のシステムと統合できます (つまり、データにアクセスするための HTTP プロトコル。通常は REST API と呼ばれます)。JSON コンテンツ タイプをサポートする REST API のみ (つまり API で Content-type ヘッダーに application / json が指定されている、および Accept に application/ json が指定されている) はサポートされますが、xml、binary、x-www-form-urlencoded などの他のコンテンツ タイプはサポートされていません。
Composer の作成者は、REST API タイプの新しいデータ接続を作成できます。他のデータ接続と同様に、このデータ接続は、ソリューション スコープ、またはアプリ スコープまたはグローバル スコープの接続ライブラリで作成できます。また、REST API データ接続は、Query コントロール、ルックアップ コントロール、Web サービス コントロール、参加者リゾルバーなどの他の機能で使用できます。
認証
API 接続の資格情報は、API データ接続の作成中に追加できます。[システム資格情報を有効にする] というラベルの付いたトグルを有効にするか、[データ ソース資格情報] に移動します。
-
システム資格情報を有効にする: このトグル ボタンを有効にすると、ここで入力する資格情報を認証に使用できます。また、ユーザー レベルの資格情報がシステム資格情報とともに追加された場合、システム資格情報はユーザー レベルの資格情報よりも優先されます。有効な場合 - ユーザーは、このページでデータ ソース接続を作成するときに資格情報を入力する必要があります。 (ユーザー名とパスワードが表示されます) 無効な場合 - ユーザーは [データ ソース資格情報] ページで資格情報を入力する必要があります (ユーザー名とパスワードは非表示になります)。
-
ユーザー レベルの資格情報: Evolve の右上隅に移動し、ユーザー名をクリックしてから [データ ソース資格情報] を選択することにより、ユーザー レベルで追加されます。認証タイプが Basic、Sap Hana Basic、または Salesforce であり、[システム資格情報を有効にする] が有効である場合、ユーザーは Rest API 接続の資格情報を追加できます。
API にアクセスするには、Evolve url と特定のキーワードを組み合わせた、たとえば <Evolve URL >/svr などのルートプレフィックスが必要になります。
データ ソース資格情報
追加
[追加] を選択すると、ユーザーは認証タイプ Basic、Sap Hana Basic、または Salesforce を使用して REST API データ接続の資格情報を取得でき、[システム資格情報を有効にする] がオフになっている必要があります。
編集
[接続を編集] を選択すると、ユーザーは [編集オプション] を使用して資格情報を編集できる必要があります。
削除
[追加されたを編集] を選択すると、ユーザーは [削除オプション] を使用して資格情報を編集できる必要があります。
REST 形式の Evolve API の公開と活用
以下の API は、API Gateway とそのサポートされている認証メカニズムで保護されています。
API ゲートウェイの 3 つのセキュリティ オプションについて、API を起動するために使用する必要がある次のルート プレフィックスがあります。
クライアント シークレット : “<Evolve URL>/svr”
セキュア トークン : “<Evolve URL>/svr”
証明書 : “<Evolve URL>/svrc”
| API 名 | HTTP メソッド | ルート | 説明 |
|---|---|---|---|
| リファレンス データ | GET |
<ルート プレフィックス>/api/v1/ReferenceData?AppName=<AppName>&LibraryName=<LibraryName>&SolutionName=<RefSolutionName> |
この API を使用して、リファレンス データ ソリューションのデータにアクセスします。 制限付き OData フィルタもこの API でサポートされています。 |
| ソリューション データ | GET | <ルート プレフィックス>/api/v1/SolutionDataSet?AppName=<AppName>&SolutionDataName=<SolutionName> |
この API を使用して、ソリューションのデータにアクセスします。 制限付き OData フィルタもこの API でサポートされています。 |
| 監視 (システム アラート) | GET | <ルート プレフィックス>/api/v1/Monitoring/SystemAlerts/?NotificationId=<通知 Id> | この API は、存在する場合、管理ダッシュボードの [システム アラート] セクションに表示される Evolve システム アラートを返します。 |
| 監視 (システム アラートの無視) | POST | <ルート プレフィックス>/api/v1/Monitoring/SystemAlerts/Dismiss?NotificationId=<通知 Id> | この API を使用して、指定された通知 ID の通知を無視/削除します。 |