ライセンス API

Control Room によってインストールされたライセンスの詳細なライセンス情報を返します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。実行する各 API にトークンを適用します。
ロールとライセンス
次の権限を持つユーザーによる認証が必要です。
ライセンスを表示
ユーザーのデバイスライセンスを管理
ライセンスをインストール
注: 管理者ユーザーは、デフォルトでこれらの権限を持っています。管理者以外のユーザーに割り当てるカスタム ロールを作成して、ライセンス情報を表示できるようにします。
  • URL: http://<your_control_room_url>/v2/license
  • メソッド: GET

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークン (JWT) を生成します。必要なロールとライセンスを持つユーザーを認証します。
    Swagger の場合:
    1. [承認] をクリックし、[値] フィールドに JWT を追加します。
    2. [承認] をクリックし、[閉じる] をクリックします

    REST クライアント の場合: 属性値 として JWT を使用し、「X-Authorization」 という名前のカスタム ヘッダーを作成します。

  2. ライセンス API の URL に移動します。.../v2/license
    Swagger の場合:
    1. [試してみる] をクリックします。
    2. [実行] をクリックします。
    REST クライアント の場合:
    1. [URL] フィールドにライセンス API の URL を入力します。
      http://<your_control_room_url>/v2/license
    2. GET メソッドを選択します。
    3. [送信] をクリックします。
    レスポンス本文:
    {
      "licenseType": "PURCHASED",
      "installedBy": 1,
      "installationDate": "2019-11-12T07:18:17.247Z",
      "expirationDate": "2020-05-10T23:59:59.999999999Z",
      "products": [
        {
          "id": 1,
          "name": "CONTROLROOM",
          "version": "11.3.4.0",
          "features": [
            {
              "id": 2,
              "name": "UNATTENDED_BOTRUNNER",
              "enable": true,
              "purchasedCount": 5,
              "usedCount": 1,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            },
            {
              "id": 1,
              "name": "BOT_CREATOR",
              "enable": true,
              "purchasedCount": 10,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            },
            {
              "id": 7,
              "name": "ATTENDED_BOTRUNNER",
              "enable": true,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            }
          ]
        },
        {
          "id": 2,
          "name": "ANALYTICS",
          "version": "11.3.4.0",
          "features": [
            {
              "id": 5,
              "name": "ANALYTICS_API",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            },
            {
              "id": 4,
              "name": "ANALYTICS_CLIENT",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            }
          ]
        },
        {
          "id": 4,
          "name": "COGNITIVE",
          "version": "",
          "features": [
            {
              "id": 3,
              "name": "IQBOT_RUNNER",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            },
            {
              "id": 8,
              "name": "IQBOT_PAGES",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            }
          ]
        },
        {
          "id": 3,
          "name": "BOTFARM",
          "version": "",
          "features": [
            {
              "id": 6,
              "name": "BOTFARM_RUNNER",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "SECONDS",
              "licenseModel": "HOURLY"
            }
          ]
        }
      ]
    }
    レスポンス ヘッダー:
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
     content-length: 1474 
     content-security-policy: default-src 'self' 
     content-type: application/json 
     date: Wed, 13 Nov 2019 10:33:56 GMT 
     expires: 0 
     pragma: no-cache 
     x-content-type-options: nosniff 
     x-frame-options: SAMEORIGIN 
     x-xss-protection: 1; mode=block 

次のステップ

コマンドまたはターミナル ウィンドウで URL を使用して、この API リクエストを行うこともできます。
curl -X GET "http://<your_control_room_url>/v2/license" -H "accept: application/json" -H "X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxOCIsImNsaWVudFR5cGUiOiJXRUIiLCJsaWNlbnNlcyI6WyJERVZFTE9QTUVOVCJdLCJhbmFseXRpY3NMaWNlbnNlc1B1cmNoYXNlZCI6eyJBbmFseXRpY3NDbGllbnQiOnRydWUsIkFuYWx5dGljc0FQSSI6dHJ1ZX0sImlhdCI6MTU3MzY0MTIxOCwiZXhwIjoxNTczNjQyNDE4LCJpc3MiOiJBdXRvbWF0aW9uQW55d2hlcmUiLCJuYW5vVGltZSI6NDE5MDkwNzU3ODk4MjIwMCwiY3NyZlRva2VuIjoiN2YxNDJiODQ3OGRhY2MzYzUzNjFiNzQwNTljOTFjMmYifQ.b5FECqRdLb4tOWrScYSGwydJ2kHdx4XX_9LYQjKX-taOynEE0P1KozHrYEsqERMQFKNTdUWnkKzHfXHWJ63IVzsSamSRLxWTWF0LiVkrrrdSA5mOtBJd3AdVC2Zxk828T2DGKX7O4U-kzSos-LM9Hcx6gug86BWPubjuHbH5RZKUgXVYujcHIpw_2sPfQFHjHdvZWb2HwuTeTm_xxiTRS4LFOwoGh3lZdmOZ8ckmGQCkB-bX28a4dfyLCPBAB9XDYGKJ70IeQRgx4mhYVJ2g228iSe8GPWYcg2RiwedawP_vxy6VLY6EDqUB7nbt5GuWf6W174S_AQei4LVYRQvsPQ"