SAP Data API は、SAP からのデータのアップロードとダウンロードに公開されています。API は Evolve および Studio Manager の両方で利用可能です。このソリューションは、スクリプト ワークフロー設定とともにスクリプト ワークフローによって管理されます。API は、SAP にデータを投稿するための JSON ペイロードとその他の詳細 (SAP、実行設定など) を公開します。
Evolve から SAP Data API にアクセスするには、次のステップに従います。
- 有効な SAP Data API ライセンスをアクティブにします。
- SAP API ストア ライブラリを作成します。
- Evolve から SAP API を追加する際に使用するスクリプトを Studio で作成します。SAP Data API with Studio で SAP Data API との統合のためのスクリプトを作成するために参照してください。
- [ソリューション] タブから SAP API を追加します。
SAP API ストア ライブラリ
SAP Data API のソリューションを Evolve に保存するには、ユーザーは Evolve から新しいライブラリを作成する必要があります。以下は、新しいライブラリを作成する手順です。
-
ライブラリを作成する必要があるアプリで、[Evolve] → [構成] → [ライブラリの管理] に移動します。
-
[追加] をクリックします。
-
選択するタイプは SAPAPIStore である必要があります。
-
ライブラリの名前と説明を入力します。両方とも必須のフィールドです。
-
実行時に SAP API ソリューションのドキュメントを生成する場合は、[ドキュメント履歴を有効にする] をオンにします。デフォルト値は false になります。
-
[保存] をクリックします。
-
[ソリューション] ページに移動すると、新しいライブラリが他のすべてのライブラリと一緒に表示されます。
SapIntegrationAPIEnable キーが有効になっている場合、SAPAPIStore ライブラリ タイプもすべての Evolve アプリで有効になります。このライブラリは、参照データ アプリでは使用できません。SAPAPIStore ライブラリ タイプは、ライブラリの追加で有効になります。このライブラリを追加できるのは、アプリ管理者とグローバル管理者のみです。
「SAPAPIStore」タイプのライブラリ権限を管理するには、[構成] → [Evolve からライブラリを管理] に移動し、テーブル グリッドにあるチェックボックスをクリックして SAP Data API を選択します。[ライブラリ権限の管理] をクリックします。フォーム ライブラリと同様に、SAPAPIStore ライブラリにも、SAPAPIStore ライブラリの権限を管理するためのプロセス権限とライブラリ ソリューション権限の 2 つの管理権限オプションがあります。プロセス権限では、デフォルトの権限が 発信者 に設定されています。ユーザーは、デフォルトの権限を削除し、発信者権限の任意のグループを追加できます。ライブラリ ソリューション権限のデフォルトの権限は、ソリューション開発者および ソリューション レビュー担当者に設定されています。ユーザーは、デフォルト権限を削除し、ソリューション開発者およびソリューション レビュー担当者権限の任意のグループを追加できます。
SAP API 承認設定は、次の 3 つのオプションを使用して、[アプリ] → [設定] → [デザイン設定] ページに追加できます。3 つのオプションすべてのデフォルト値は false です。
-
ソリューションの承認: True に設定すると、Evolve に送信されたソリューションは、レビュー担当者がタスクから承認するまでレビュー中です。
-
自己承認: True に設定すると、ユーザー送信ソリューションはソリューションを自己承認でき、SAP Data API の送信または更新中に、ユーザーの名前がレビュー担当者のリストに表示されます。
-
ソリューション拒否の理由: True に設定した場合、ユーザーはソリューションを拒否する理由を定義する必要があります。
[ソリューション] タブから SAP API を追加します
ソリューションから SAPAPIStore ライブラリを選択すると、API の追加が利用可能になります。このオプションは、ログ インしているユーザーがソリューション開発者のロールを持っている場合にのみ表示されます。許可されたユーザーは、[API の追加] をクリックして、スクリプトを使用して SAP から JSON スキーマへデータをアップロード/ダウンロードするために Web API スキーマを生成できます。
[API の追加] は 、 [API 情報]、[ファイルの選択]、 [レビュー担当者の選択] を含む 3 つのステップのウィザードを 3 つのステップとしてポップ アップ表示します。
API 情報には次のフィールドがあります。
-
名前: サービス/ソリューションの名前。ライブラリ レベルで一意である必要があります。
-
カテゴリ: ソリューション ページのフィルターを使用して後でフィルターで除外できるさまざまなカテゴリにソリューションを分類するのに役立ちます。カテゴリは必須フィールドではありません。
-
説明: ユーザーがソリューションのすべてを説明するために使用できます。説明は必須フィールドではありません。
API 作成には、[Transaction から作成] と [Query から作成] の 2 つのオプションがあります。デフォルトのオプションは[Transaction から作成] です。API 作成には次のフィールドがあります。
-
ファイルを選択: API スキーマの生成には、JSON マップ スクリプトのみがサポートされます。スクリプトがクエリ タイプの場合、システム使用レベル (低、中、高) が表示されます。
-
視聴者: 2 つの JSON ビューアー テキスト エリアと JSON ビューアーがあります。デフォルトの選択は JSON ビューアーです。どちらのビューアーも幅と高さが固定されており、JSON テキストに従ってスクロール バーを有効にします。
Evolve で使用するには、Studio でスクリプトを作成する必要があります。SAP Data API with Studio で SAP Data API との統合のためのスクリプトを作成するために参照してください。
ファイルの選択から有効なスクリプト ファイルを参照した後、サービス メソッド呼び出しは API 仕様を生成し、それを JSON ビューアーに表示します。JSON には、InputPayload、OutputPayload、 ErrorPayload の 3 つのタブがあります。InputPayload および OutputPayload の API 仕様はスクリプト ファイルに従っており、ErrorPayload は固定配列です。スクリプト データ型と API 仕様に対応するデータ型は、生成されたペイロードで利用可能になります。
InputPayload と OutputPayload には、次のセクションがあります。
-
RunParameter: Transaction のすべての入力フィールドがあります。Query スクリプトは、すべてのユーザー定義の基準フィールドを表示し、固定基準フィールドを無視します。
-
SolutionDetail: SolutionName、LibraryName、AppName の各フィールドがあります。
-
RequestParameter: すべての実行時入力があります。たとえば、Record Count、GetRecordCount などです。
-
SAPDetails: 必須フィールドとして ConnectionName と EvolveUser があります。SAPUser、SAPCredentials、WindowsCredentials などの他のフィールドはオプションのフィールドです。
SAP API の承認設定の下のソリューション承認フラグが true に設定されている場合、レビュー担当者の選択が表示されます。[レビューワー] ドロップダウンには、現在のアプリでソリューション レビューアーの役割を持つすべてのユーザーが表示されます。[自己承認] 設定が false の場合、現在のユーザーにアプリでソリューション レビューアー役割があったとしても、現在ログインしているユーザーは表示されません。ソリューションは、レビューアーを選択していない状態では送信できません。
ソリューションの送信後、ソリューション ページの [ソリューション]、[説明]、[ステータス]、[カテゴリ]、[レビュー者]、および [作成者] 列に表示されます。
SAP Data API の URL は次のようになります<RoutePrefix>/api/v1/SAPIS
SAP API 承認設定のソリューション承認フラグが true の場合、レビュー担当者を使用してソリューションを送信する必要があります。ソリューションの送信後、タスクはレビューのためにレビュー担当者に割り当てられます。ソリューション拒否の理由設定がオンに設定されている場合、ソリューション レビュー担当者は拒否コメントを指定する必要があります。ソリューション ワークフローが適用されている場合、API の更新は、ソリューションが実稼働状態にある場合にのみ機能します。
[ソリューション] タブから SAP API を更新します
ユーザーは、実稼働状態のソリューションにAPI の更新を使用できます。SAP API 承認設定 ([アプリ] → [設定] → [デザイン設定] ページ) で、ソリューションの承認がオンになっている場合、割り当てられたレビュー担当者によって承認されるまで、ソリューションはレビュー中です。レビュー中のソリューションは更新できません。ソリューションを承認して実稼働に移行した後、ユーザーは SAP Data API ソリューションを更新できます。ソリューション レビューがオフの場合、ソリューションは常に実稼働にあり、ユーザーは SAP API ソリューションを編集できます。以下は、API を更新するための詳細です。
-
ソリューションに移動し、SAP Data API ライブラリを選択します。
-
ソリューション グリッドにあるチェックボックスをクリックして、更新する (実稼働の) SAP API ソリューションを選択します。
-
[APIの更新] をクリックします。
-
サービス/ソリューションの名前は読み取り専用です。カテゴリと説明は編集可能です。
-
スクリプト タイプは既存のスクリプト タイプに従って選択され、他のオプションは無効になります。ファイルの選択は、同じタイプのスクリプトを追加できます。
-
サービス URL および JSON ビュー (テキスト エリアおよび JSON ビューアー) は読み取り専用です。
-
SAP API の承認設定の下のソリューション承認フラグが true に設定されている場合、これらのステップが表示されます。[レビューアー] ドロップ ダウンには、現在のアプリでソリューション レビューアーの役割を持つすべてのユーザーが表示されます。現在のソリューション レビュー担当者がレビュー担当者リストにある場合は、同じレビュー担当者が選択されます。
-
[自己承認] 設定が false の場合、現在のユーザーにアプリでソリューション レビューアー役割があったとしても、現在ログインしているユーザーは表示されません。ソリューションは、レビューアーを選択していない状態では送信できません。
-
このアクションにより、ソリューションの新しいバージョンが作成されます。
SAP API を表示する
SAP API を表示するには、SAP API ライブラリから特定のソリューションを選択した後、[API の表示] オプションをクリックします。完全なデータは、参照スキーマ ビューのように、単一のページに表示されます。JSON はテキスト エリアと JSON ビューの両方で表示できます。
サービスの URL は次のように表示されます <BaseURL/GatewayURL>/api/v1/SAPIS。
SAP Data API の実行
Integration API を実行するには、ユーザーは認証ヘッダーとペイロードを入力し、実行のために有効な公開エンド ポイントに送信します。SAP Data API を実行するには、以下の手順に従います。
-
実行前に、Authentication ヘッダー、SolutionName、LibraryName、AppName、ConnectionName、EvolveUser などのペイロードのすべての必須入力フィールドに入力します。
-
Evolve ユーザーは、API を実行するための発信者のロールを持っている必要があります。
-
Transaction の場合 - 実稼働状態の SAP Data API ソリューションは、実稼働サーバーで実行できます。ソリューションの最新バージョンが適用されます。レビューまたは拒否状態の SAP Data API ソリューションは、非稼働 SAP システムで実行できます。検証は、実稼働 SAP システムと非稼働 SAP システムの両方で実行されます。
Query の場合 - 実稼働状態の SAP API ソリューションは、実稼働と非稼働の両方のサーバーで実行できます。ソリューションの最新バージョンが適用されます。レビュー状態または拒否状態の SAP API ソリューションは、非稼働 SAP システムで実行できます。
-
EvolveUserは、SAP 資格情報と Windows 資格情報が渡されない場合に、ロールとポリシーを確認し、指定された ConnectionName に対してログイン資格情報をチェックするために使用されます。
SAP API ソリューションを実行するための優先基準は次のとおりです。
-
SAP 資格情報です。
-
Windows 資格情報です。
-
Evolve ユーザーです。
デフォルトの設定では、EvolveUser を使用して、ネットワーク上でプレーン テキストのパスワードを使用しないようにします。
-
-
実行後、実行結果 (ログ フィールドと出力フィールド) は JSON ドキュメントに上書きされます。
-
ライブラリでドキュメント履歴が有効になっている場合、ドキュメントは ServiceName_TimeStampとして (数値で) 一意に識別されます。ドキュメントは、JSON 形式の InputPayload と OutputPayload を含むテキスト ファイルになります。ユーザーがパスワードを指定した場合、そのパスワードはドキュメントに保存されません。ドキュメントにはワークフローがないため、ステータスは常に完了になります。
API の使用状況を表示するには、ソリューション ライブラリから任意のソリューションを選択し、[API の使用状況] をクリックします。API の使用状況ビューには、タイトル、データ ファイル、アクティビティ日時、SAP システム、アップロードされたレコード、および API 実行の詳細情報を表示する実行エラー列があります。
統合 API ソリューションをインポート/エクスポートするには、ソリューション (つまりテスト) に移動し、スクリプトをダウンロードします。これで、ダウンロードしたスクリプトを使用して新しいソリューションを追加できます。