Help

Web API

このトピックでは、ISPW APIの概要とCompuware Enterprise Services（CESイベント）への認証およびWebフック通知の認証について説明します。

APIドキュメント

ISPW WebインターフェースのAPIドキュメントは、ここから入手できます。

概要図

この図は、ISPW REST APIの実装に含まれるさまざまなコンポーネント間の相互関係を示しています。

ISPW Web APIの有効化

ISPWのREST APIを使用するには、以下の手順に従います。

  1. ISPW CIタスクにパラメーター「WZCIXPRT」が定義されていることを確認します。詳細については、『ISPWインストール／構成ガイド』の表4-1を参照してください。

  2. ISPW CMタスクJCLに、ETPLIB、ETPLOG、WQPLIB、およびWQPLOG DDステートメントが含まれていることを確認します。詳細については、『ISPWインストール／構成ガイド』の図4-4を参照してください。

  3. ISPW CMタスクのSDEFINIパラメーター ファイルに、「WEBAPI=Y」を追加します。詳細については、『ISPWインストール／構成ガイド』の表4-3を参照してください。

  4. CMSCパラメーターに、「CES_HOSTNAME」（PTF CXS028Aがインストールされている場合は「CES_HOST」）と「CES_PORT」を追加します。詳細については、『エンタープライズ共通コンポーネント インストール／カスタマイズ・ガイド』を参照してください。

  5. CESの [管理]>[セキュリティー] で、個人用アクセス トークンを追加または作成します。トークンの追加または作成する方法については、CESオンライン ヘルプで個人用アクセス トークンの設定に関するトピックを参照してください。

  6. 以下の必要なソフトウェア リリースがインストールされ、使用されていることを確認します。

    • ISPW 18.02と最新の保守

    • ECC 17.02と最新の保守

    • CES 18.02.02（最小要件）

CESによる認証

認証は、個人用アクセス トークンを使用して実行され、ISPW API要求をISPW許可のあるTSO認証情報に関連付けて行われます。個人用アクセス トークンを作成するには、画面の左上隅にあるCESメニュー ボタンから [管理] をクリックし、次に [セキュリティー] をクリックします。[セキュリティー] 域で、[個人用アクセス トークン] を選択します。[個人用アクセス トークン] ページが表示されます。ここで、個人用アクセス トークンを作成したり編集したりできます。

メモ：セキュリティーと個人用アクセス トークンは管理機能であるため、このページにアクセスするには管理者権限が必要です。管理者は、管理者権限を持たないユーザー用にトークンを作成する必要があります。

個人用アクセス トークンはCESに保管され、許可ユーザーに代わってホストに要求を発行するのに使用されます。このトークンとすべての要求が確実に暗号化されるようにするには、HTTPSを使用することをお勧めします。ISPW API呼び出しには、ヘッダー「Content-Type」とその値「application/json」、およびヘッダー「Authorization」とその値に個人用アクセス トークンを含める必要があります。（詳細については、Compuware Enterprise Servicesのヘルプで、個人用アクセス トークンに関するトピックを参照してください）。

例：ISPW API呼び出しのヘッダー

Authorization: c343114a-a991-40b9-afe6-4846064175e2
Content-Type: application/json

Webフック通知の認証

サード パーティー製の通知に認証が必要な場合は、httpHeadersまたはcredentials JSONオブジェクトを使用して資源を呼び出す必要があります。この認証は、グローバル レベル（すべてのコールバックに対する1セットの認証情報）とコールバック レベル（特定のコールバックの認証情報のオーバーライド）で使用できます。JSON Bodyの例を以下に示します。

例：httpHeadersを使用した1つのオーバーライドされたコールバックによるグローバル基本認証

{
"credentials":{ //すべての呼び出しに基本認証を使用する
"username": "JohnDoe",
"password": "xxxxxxx"
},
"events": [{
"name":"completed",
"url":"http://myserver:48080/ISPW/Complete"
},
{
"name":"failed",
"url":"http://otherserver:48080/ISPW/Fail",
"httpHeaders": [{ // httpHeadersでグローバル認証情報をオーバーライド
"name":"Authorization",
"value":"123-456-789"
}],
}]
}