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

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

要件

この API を使用する前に、次の点に注意してください。

この API は、組織が New Relic の担当者から使用するように指示されていない限り、使用できません。
この特定のオブジェクトを使用するためのアクセス権がない可能性があります。使用する前に、まず要件をお読みください。

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

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

タイプ：	弦
デフォルト：	（無し）

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

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

conflicting_name_1
conflicting_name_2
etc.

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

このフラグにより、APIがアプリケーションデータにアクセスできるようになります。アカウントをリモート管理するパートナーシップの場合、これをtrueに設定する必要があります。

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

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

タイプ：	配列
デフォルト：	（無し）

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

ユーザーを新しいユーザーモデルに移行したカスタマーパートナーシップの場合：ユーザーを定義しないでください。このフィールドでユーザーを追加すると、それらは無視されます。代わりに、ユーザーを追加するには、これらのユーザー管理手順を使用します。
元のユーザーモデルのユーザーがいる他のすべてのアカウントの場合：最初にアカウントを作成するとき、このフィールドは必須であり、定義できるユーザーは1つだけです：アカウントOwner 。ユーザーを追加するには、 PartnershipAPIユーザーオブジェクトを使用します。
制限の詳細については、 Requirements をご覧ください。

タイプ：	配列
デフォルト：	（無し）

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

使用量ベースの料金モデルでの顧客パートナーシップの場合：このフィールドは元の料金モデルに適用され、自分の料金モデルには適用されないため、このフィールドは無視してください。これを使用すると、無視されます。
他のすべてのアカウントの場合：元の製品ベースの価格設定モデルを使用しています。新しいアカウントにはsubscriptions属性が必要です。空の場合、デフォルトの製品階層が使用されます。サブスクリプション情報を更新するには、 PartnershipAPIサブスクリプションオブジェクトを使用します。
重要
このオブジェクトを使用してアカウントを作成する場合、アカウント設定が入力されるまでに時間がかかることがあります。これは、返される応答が最初は真ではない側面を示す場合があることを意味します（たとえば、デフォルトのLiteサブスクリプションを示す応答を返す場合があります）。
空のJSON配列を指定するには、 subscriptions: [ {} ]を使用しないでください。代わりに、次の形式を使用してください。
```
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コールでアカウントを作成またはリストアップすると、アカウントのステータスが自動的に含まれます。これらのステータスの中には、すべての価格モデルに適用されないものもあります。

アカウントの状況	定義
`pending`	無料アカウントが作成されているが、プライマリ・アドミンがまだ有効になっていない。
`paid_pending`	有料会員で作成されたアカウントですが、プライマリ管理者がまだ有効になっていません。
`new`	無料アカウント、アクティブなプライマリ管理者、アプリケーションデータは収集されていません。
`paid_new`	有料のサブスクリプション、アクティブな主管理者、アプリケーションデータは収集されていません。
`active`	無料購読、アプリケーションデータの受信
`paid_active`	有料会員、アプリケーションデータの受信
`upgraded`	アカウントのサブスクリプションがアップグレードされました。
`downgraded`	アカウントのサブスクリプションがダウングレードされました。
`cancelled`	New Relic アカウントのサブスクリプションがキャンセルされました。
`suspended`	プライマリ管理者がメールアドレスを認証していないため、New Relic アカウントが停止しています。

JSONの例

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

これは単なる例であり、一部のアカウントでは、 users }属性とsubscriptions属性は不要であり、無視されることに注意してください。

{
  "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=

PartnershipAPIアカウントオブジェクトを使用した呼び出しの例を次に示します。これらは例であり、一部のアカウントでは、 users }属性とsubscriptions属性は適用されず、無視されることに注意してください。

リストリクエスト

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"
  }
}

これは、使用量ベースの価格設定モデルに基づいており、新しいユーザーモデルにユーザーがいる顧客パートナーシップのアカウントを作成する例です。 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アカウントオブジェクトを使用して更新できるのは、 name 、 phone_number 、 testing 、およびallow_API_accessの値のみです。 subscriptionとusersの値を更新するには、 PartnershipAPIサブスクリプションオブジェクトとPartnershipAPIユーザーオブジェクトを使用する必要があります。

リクエスト：

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 アカウントオブジェクト

要件 .css-21sua1{background:none;border:none;width:0;padding:0;}

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

phone_number

allow_api_access

テスト

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

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

アカウントAPIコール

ステータスの定義

JSONの例

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

JSONレスポンス

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

リスト

公演

クリエイト

アップデート

削除

要件

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

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