APIの概要

JP1/ITRMでは,JP1/ITRMが提供している機能をセルフサービスポータルなどのユーザープログラムから利用するために,HTTPプロトコルを利用したAPI(Application Programming Interface)を提供します。

なお,この章での「API」は,「JP1/ITRMが提供するAPI」を指しています。また,APIを使用するセルフサービスポータルなどのユーザープログラムを総称して「APIクライアント」と表記します。

JP1/ITRMとAPIクライアントの関係については,「JP1/ITRMサーバおよびAPIクライアントのネットワーク接続構成の検討」を参照してください。

APIを使用するには

JP1/ITRMが提供するAPIを使用するには,次の準備が必要です。

ここでは,それぞれの準備について説明します。

JP1/ITRMサーバおよびAPIクライアントのネットワーク接続構成の検討

「APIクライアント」は,ITリソースを提供する側の管理者が作成するプログラムです。APIクライアントとJP1/ITRM間は,HTTP通信を使用します。また,APIクライアントは,BASIC認証で認証します。そのため,次の図に示すとおり,APIクライアントとJP1/ITRM間の通信が,仮想ホスト利用者の属する管理用LAN以外に流れないような構成を推奨します。

図4-1 APIを使用するときの前提のシステム構成

[図データ]

APIの有効化,およびAPI用待ち受けポートの設定

APIを使用するには,APIを有効にする必要があります。

APIを有効にするには,インストーラーの指示に従って画面上で有効にする方法と,コマンドを使用して有効にする方法があります。

画面上で有効にする方法
新規にJP1/ITRMをインストールする場合に,画面上でAPIを有効にできます。
手順については,マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のインストールについて説明している章を参照してください。
コマンドで有効にする方法
次の場合に,jirmsetupコマンドまたはjirmsetportnoコマンドを使用してAPIを有効にできます。
  • JP1/ITRMがインストール済みの場合
  • JP1/ITRMのバージョンが09-51未満からバージョンアップした場合
    バージョンアップ後は,API機能が無効になっています。
  • JP1/ITRMのバージョンが09-51未満の状態でエクスポートしたデータを,JP1/ITRMのバージョンが09-51以降の環境にインポートした場合
    インポート後は,API機能が無効になっています。
jirmsetupコマンドの詳細については,「jirmsetup」(1. コマンド)を参照してください。
jirmsetportnoコマンドの詳細については,「jirmsetportno」(1. コマンド)を参照してください。

APIクライアントからアクセスするためのJP1/ITRMのIPアドレスの確認

APIのレスポンスで得られる情報の中に,JP1/ITRMのIPアドレスが含まれます。

このIPアドレスは,APIクライアントからアクセスできるIPアドレスである必要があります。JP1/ITRMのサーバに複数のIPアドレスが設定されている場合,ユーザー設定プロパティファイル(jp1itrm.properties)の指定キー(CO.ITRMServerURL)に設定されているIPアドレスを,APIクライアントからJP1/ITRMに接続するためのIPアドレスに変更してください。

ユーザー設定プロパティファイル(jp1itrm.properties)の詳細については,「ユーザー設定プロパティファイル(jp1itrm.properties)」(2. 定義ファイル)を参照してください。

APIを使用するときに用いる専用のJP1/ITRMユーザーの作成

APIを使用するには,JP1/ITRMのリソース管理ロールに属するユーザー(ロールID:_jp1resourceに割り当てられているユーザー)をAPIを使用する専用のJP1/ITRMユーザーとしてあらかじめ作成しておく必要があります。

APIを経由した参照や操作の際には,ここで作成したユーザーのIDおよびパスワードを使用します。

ユーザーの追加およびロールの割り当てについては,マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のユーザー管理の検討についての説明,およびマニュアル「JP1/IT Resource Management - Manager 運用ガイド」のユーザーとロールの管理についての説明を参照してください。

APIを使用するときの前提条件

APIを使用して参照および操作できるITリソースの種類は,リソース管理画面のリソース一覧エリアに次の状態で表示される仮想ホストです。

APIを使用してITリソースを参照および操作するためには,ITリソースを業務グループと関連づける必要があります。そのため,次の作業を必ず実施してください。

業務グループとの関連づけについては,マニュアル「JP1/IT Resource Management - Manager 運用ガイド」のITリソースの構成を把握する,およびITリソースをITリソース利用者に提供することについての説明を参照してください。

APIクライアントで実装すること

JP1/ITRMでは,APIクライアントの利用者(ITリソース利用者)を管理できません。そのため,APIクライアントでは,次の関係を管理する必要があります。

また,APIクライアントでは,APIクライアントの利用者の認証およびAPIクライアントの利用者がどのITリソースを参照・操作できるのかというアクセス権制御をする必要があります。