Partnership API アカウントオブジェクト

このドキュメントでは、 Partnership API を使用してアカウントを管理する方法を説明します。子アカウントの場合は、子アカウントオブジェクトを使用します。

要件

パートナーシップ API は、New Relic の担当者から使用するように特別に指示されない限り、あなたの組織では利用できません。

本製品の一部の機能が使用できない場合があります。ご使用になる前に、まず要件をお読みください。

アカウントオブジェクトの属性

Partnership API アカウントオブジェクトの属性を示します。

タイプ：	文字列
デフォルト：	(なし)

アカウント名属性は、新規アカウントの場合は必須です。

この名前は、New Relic のデータベースで一意でなければなりません。指定した名前が一意でない場合は、以下のように数字のサフィックスを付けて自動インクリメントされます。

conflicting_name_1
conflicting_name_2
etc.

タイプ：	ブール値
デフォルト：	false

このフラグは、アプリケーションデータへのAPIアクセスを許可するものです。これは、リモートでアカウントを管理しているパートナーシップのために、 true に設定する必要があります。

タイプ：	ブール値
デフォルト：	false

テストアカウントであることを示すために、このフラグを使用します。テストアカウントは、ゴミのようなデータを含んでいると想定され、内部システムでは無視されます。テストアカウントが生成したデータは、いつでも削除することができます。

タイプ：	配列
デフォルト：	(なし)

ユーザーのリストを定義する配列です。アカウントの状態に応じて、いくつかの制限があります。

顧客のパートナーシップについて New Relic One ユーザーモデルに切り替えた場合: ユーザーを定義しないでください。このフィールドでユーザーを追加しても、無視されます。代わりに、ユーザーを追加するには、以下のユーザー管理手順を使用します。.
その他のすべてのアカウントで、当社のオリジナルユーザーモデルにユーザーがいる場合: 最初にアカウントを作成する際、このフィールドは必須であり、定義できるユーザーはアカウント オーナー のみです。追加のユーザーを追加するには、 Partnership API ユーザーオブジェクトを使用します。
制限の詳細については、 Requirements をご覧ください。

タイプ：	配列
デフォルト：	(なし)

サブスクリプションのリストを定義する配列です。お客様のアカウントの状態によっては、いくつかの制限があります。

お客様のパートナーシップについて当社の New Relic One の価格モデルについて: このフィールドは、お客様の価格モデルではなく、元の価格モデルに適用されるため、無視してください。これを使用した場合、無視されます。
その他のアカウントの場合お客様は、当社のオリジナルの製品ベースの価格モデル。 subscriptions 属性は、 新規アカウントには必須 です。この属性が空の場合、デフォルトの製品階層が使用されます。サブスクリプション情報を更新するには、 Partnership API subscription object を使用してください。
重要
このオブジェクトでアカウントを作成する場合、アカウント設定が反映されるまでに時間がかかることがあります。つまり、返されたレスポンスには、最初は真ではない部分が表示されることがあります（例えば、デフォルトの Lite のサブスクリプションを示すレスポンスが返されることがあります）。
空のJSON配列を指定するには、 サブスクリプションを使用しないでください。[ {} ] 。代わりに、このフォーマットを使用します。
```
subscriptions: [  ]
```

account API には、子アカウントを作成するための属性はありません。代わりに、子アカウントを作成するには、親アカウントの アカウント設定 ページを New Relic UI で使用します。

アカウントAPIコール

以下に、アカウントAPI機能のURLパターンを示します。このURLパターンを使用する場合は、 Partner API key を含むHTTPヘッダをJSONリクエストボディと一緒に送信してください。例えば、以下のようになります。

GET .../api/v2/partners/:PARTNER_ID/accounts/:ID
x-api-key: :PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

コール	リソースURLパターン
パートナーの全アカウントを一覧表示（index ）。	`GET /api/v2/partners/PARTNER_ID/accounts`
Show アカウントの属性を表示します。	`GET /api/v2/partners/PARTNER_ID/accounts/:ID`
アップデートアカウントの属性を変更します。	`PUT /api/v2/partners/PARTNER_ID/accounts/:ID`
指定されたパラメーターでアカウントを作成します。	`POST /api/v2/partners/PARTNER_ID/accounts`
Cancel an account.	`DELETE /api/v2/partners/PARTNER_ID/accounts/:ID`

ステータスの定義

APIコールでアカウントを作成またはリストアップすると、アカウントのステータスが自動的に含まれます。これらのステータスの中には、すべての価格モデルに適用されないものもあります。

アカウントの状況	定義
`ペンディング`	無料アカウントが作成されているが、プライマリ・アドミンがまだ有効になっていない。
`支払い済み・保留中`	有料会員で作成されたアカウントですが、プライマリ管理者がまだ有効になっていません。
`新`	無料アカウント、アクティブなプライマリ管理者、アプリケーションデータは収集されていません。
`ペイド・ニュー`	有料のサブスクリプション、アクティブな主管理者、アプリケーションデータは収集されていません。
`アクティブ`	無料購読、アプリケーションデータの受信
`paid_active`	有料会員、アプリケーションデータの受信
`アップグレード`	アカウントのサブスクリプションがアップグレードされました。
`格下げされた`	アカウントのサブスクリプションがダウングレードされました。
`キャンセル`	New Relic アカウントのサブスクリプションがキャンセルされました。
`サスペンド`	プライマリ管理者がメールアドレスを認証していないため、New Relic アカウントが停止しています。

JSONの例

以下は、Partnership API のアカウントオブジェクトを使用した JSON リクエストとレスポンスの例です。

なお、これは一例であり、アカウントによっては、 users and subscriptions attributes が不要であり、無視される場合があります。

{
  "account": {
    "name": "Sample Account",
    "application_type": "ruby",
    "users": [
      {
        "email": "sample_user@sample.org",
        "password": "XXXXXXXX",
        "owner": true,
        "role": "admin",
        "first_name": "Sample",
        "last_name": "User"
      }
    ],
    "subscriptions": [
      {
        "product_id": 4,
        "quantity": 10
      },
        {
        "product_id": 10,
        "quantity": 0
      }
    ],
    "allow_api_access": true,
    "phone_number": "555-555-5555"
  }
}

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1990.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

アカウントオブジェクトAPIの例

アカウント数が1000を超えるパートナーシップでは、ページ分割された応答が返されます。ページを指定するには、クエリに以下のパラメータを追加します。

?page=

これらは例であり、一部のアカウントでは users and subscriptions attributes が適用されず、無視されることに注意してください。

リストリクエスト

curl -X GET \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts

応答（改行は読みやすさのため）。

{
  "accounts": [
    {
      "id": XXXXXX,
      "name": "Sample Account",
      "status": "pending",
      "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
      "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
      "browser_monitoring_key": "66617123f5",
      "allow_api_access": true,
      "high_security": false,
      "testing": null,
      "partner_external_identifier": null,
      "subscription": {
        "id": XXXXXX,
        "starts_on": "2016-05-17",
        "expires_on": null,
        "annual_renewal_on": null,
        "products": [
          {
            "product_id": 4,
            "name": "Pro",
            "units": 10,
            "price": 1990.0
          },
          {
            "product_id": 10,
            "name": "Mobile Lite",
            "units": null,
            "price": 0.0
          },
          {
            "product_id": 20,
            "name": "Browser Lite",
            "units": 0,
            "price": 0.0
          },
          {
            "product_id": 16,
            "name": "Insights None",
            "units": 0,
            "price": 0.0
          },
          {
            "product_id": 23,
            "name": "Synthetics Lite",
            "units": 0,
            "price": 0.0
          }
        ]
      },
      "primary admin": {
        "id": XXXXXX,
        "email": "sample_user@sample.org",
        "first_name": "Sample",
        "last_name": "User",
        "state": "active"
      }
    }
  ]
}

リクエスト

curl -X GET \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

応答（改行は読みやすさのため）。

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": 00000,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

ここでは、オリジナルの価格モデルとオリジナルのユーザーモデルを持つ組織のアカウントを作成する例を紹介します。新しいモデルを使用している組織のアカウント作成の例は、この後の例をご覧ください。

curl -X POST \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"account":{"name":"Sample Account", "users":[{"email":"sample_user@sample.org", "password":"XXXXXX", "first_name":"Sample", "last_name":"User", "role":"admin", "owner":"true"}],"subscriptions":[{"product_id": 4,"quantity": 10},{"product_id": 10,"quantity": 0}]}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/

応答（改行は読みやすさのため）。

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

ここでは、当社の New Relic One の価格設定と New Relic One のユーザーモデルを利用している顧客パートナーシップのアカウントを作成する例を示しています。API 利用の制限については、要件を参照してください。

curl -X POST \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY'   \
    -H 'Content-Type:application/json'  \
    -d '{"account":{"name":"Sample account"}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/

Partnership API account オブジェクトを使用して更新できるのは、 name, phone_number, testing and allow_API_access の値のみです。 subscription および users の値を更新するには、 Partnership API subscription オブジェクトおよび Partnership API user オブジェクトを使用する必要があります。

リクエスト

curl -X PUT \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"account":{"name":"Sample account name"}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

応答（改行は読みやすさのため）。

{
  "id": XXXXXX,
  "name": "Account New Name",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

リクエスト

curl -X DELETE \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

応答します。レスポンスボディはありません。

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

Partnership API アカウントオブジェクト

要件

アカウントオブジェクトの属性

名前（アカウント作成時には必須）

phone_number

allow_api_access

テスト

ユーザー（一部のアカウントでは必須）

サブスクリプション（一部のアカウントでは必須）

重要

アカウントAPIコール

ステータスの定義

JSONの例

アカウントオブジェクトのJSONリクエスト

JSONレスポンス

アカウントオブジェクトAPIの例

リスト

ショー

クリエイト

アップデート

削除

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

Partnership API アカウントオブジェクト

要件

アカウントオブジェクトの属性

phone_number

allow_api_access

テスト

ユーザー （一部のアカウントでは必須）

サブスクリプション （一部のアカウントでは必須）

アカウントAPIコール

ステータスの定義

JSONの例

アカウントオブジェクトのJSONリクエスト

JSONレスポンス

アカウントオブジェクトAPIの例

リスト

ショー

クリエイト

アップデート

削除

ユーザー（一部のアカウントでは必須）

サブスクリプション（一部のアカウントでは必須）