IBM Support

ReaQta: API クライアントの認証について

How To


Summary

この技術情報では、API クライアント・アプリケーションの認証処理についてご案内します。

Steps

 ReaQta API では、API クライアントの認証に「 JSON Web Token（JWT）」を使用し、JWT は Hive サーバーから発行されます。

API クライアントは、これらトークンの生成と更新を自動的に処理するため、クライアントのインスタンスを生成する際に、アプリケーション ID と秘密鍵を提供する必要があります。

外部の API クライアントを認証するには、クライアントから POST メソッドを使用した API リクエストを送信する必要があります。

 image-20220401133809-1

実行手順:

  1. メソッド: POSTメソッドを使用します。
  2. リクエスト URL: API コール「 /1/authenticate 」を用いて認証リクエストを行います。リクエスト URL は以下のようになります。 
    https://<Hive Server URL>/rqt-api/1/authenticate
    • 注: ReaQta API を使用する際は、API コールの接頭辞に「 /rqt-api/ 」を追加することを確認してください。
  3. リクエストボディ: Hive サーバーに作成された API アプリケーションの App ID ( アプリケーション ID) と Secret Key ( 秘密鍵 )を指定します。API アプリケーションの詳細については、「 ReaQta: Hive サーバー・ダッシュボードから API アプリケーションを作成する方法 」をご参照ください。 
    {
  "secret": "<Enter the Secret Key string>",
  "id": "<Enter the App ID string>"
}
  4. ヘッダー: 必要な HTTP ヘッダーを指定していることを確認してください。
    例： 
    ContentType: application/json
  5. レスポンス: API リクエストの成否に応じて、以下のレスポンス・コードが返されます。
    ステータス・コード 説明 レスポンスの値の例
    200 問題無し 
    {
  "token": "xxxxx.yyyyy.zzzzz",
  "expiresAt": 1617982282
}
    401 認証されていない 
    {
  "message": "Authentication failed"
}

Additional Information

すべての API リクエストの実行を成功させるには、まず API クライアントを認証して、認証成功後のレスポンスで生成されたトークンを、以下の方法でヘッダーとして指定する必要があります。
Authorization: Bearer <token>

Document Location

Worldwide

本文書は、米国 IBM 社の資料を翻訳した参考文書です。翻訳元の文書は、Related Information の翻訳元 (英語) リンクよりご参照ください。

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSVOEH","label":"IBM Security ReaQta"},"ARM Category":[{"code":"a8m3p000000hBSaAAM","label":"Configuration"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
22 June 2022

UID

ibm16597157

Page Feedback