APIの使用

ドキュメントやUIから直接APIキーにアクセスしたり、APIキーを生成したりすることができる。

手順

以下のいずれかの方法で、APIキーの詳細にアクセスまたは生成します。
APIアクセス方法 手順
のヘッダーから
  1. 管理者として、 ヘルプアイコンをクリックし、次に API をクリックします。
  2. APIキーの詳細をコピーします。
のサイドナビゲーションメニューから
注: 9.0 から、.NET Framework で API キーを生成できるようになりました。
  1. 管理者として、サイドバーのメニューから 「設定」 をクリックし、「APIキー」 をクリックします。
  2. APIキーのページで APIキーを検索するか、新しいAPIキーを生成する必要がある場合は 、「APIキーを生成」 をクリックします。
  3. APIキーの説明、役割、有効期限（該当する場合）を入力し、「キーを生成」 をクリックします。
  4. APIキーの詳細をダウンロードまたはコピーします。
    注： APIキーの詳細をコピーまたはダウンロードせずにモーダルを閉じた場合、それ以降は詳細にアクセスできなくなります。
  1. APIキーとトークンをコピーする。
    注： 専用については、管理者にお問い合わせください。
    8.9、またはそれ以前のバージョンを使用している場合は、以下の手順に従ってください：Maximo Application Suite 顧客管理
    1. で、 プロジェクトを選択する。
    2. mas-dev-monitorプロジェクトを選択する。
    3. 「Workload」 をクリックし、「Secrets」 をクリックします。
    4. monitor-api秘密ファイルを開きます。
    5. as_apikey と as_apitoken の値をコピーします。

    8.10 以降を使用している場合は、管理者アクセス権を持っていることを確認してください。 次に、 API ページの、 APIキーと APIトークンのフィールドにある値をコピーする。

    8.10 以降では、ツールAPIキーまたはAPIキーを使用してAPIを実行できます。 ツールのAPIキーを使用すると、ユーザーごとに1つなど、複数のAPIキーを作成できます。

  2. APIドキュメントで、指定するAPIについて、[ Try it out] をクリックします。
  3. 「実行 (Execute)」をクリックします。

POST、 PUT、または DELETE のすべてのコールにおいて、 tenantid および mam_user_email のヘッダーを使用してください。 mam_user_email ヘッダーには、ユーザープロファイルに関連付けられているメールアドレスを使用してください。 ヘッダーを使用しない場合は、403 Forbidden不正なエラーが発生します。

注： 製品のインストール時に、アプリケーションスイートの管理者がワークスペースID （テナントIDまたは組織IDとも呼ばれる）を設定します。

GET のすべてのコールでは、 tenantid ヘッダーを使用し、必要に応じて mam_user_email ヘッダーも使用してください。 tenantid ヘッダーを使用しない場合、403 Forbidden不正なエラーが発生します。

PostmanのようなAPIアプリケーションを使ってAPIにアクセスする場合、APIコールでホスト URL。 Dedicatedでは、APIエンドポイントのホスト URL、ウェルカムレターに記載されています。 顧客が管理する環境では、ホスト URL は https://workspaceId.api.monitor.domain.com。