Partnership APIリファレンス

このドキュメントでは、Partnership API の使用に関する技術的な詳細を説明します。導入および要件については、まず Partnership API の導入 をお読みください。

要件

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

要件については、 Intro to Partnership API を参照してください。

Partnership API キーの検索

Partnership API では、 REST API キー で認証する必要があります。これは、お客様の パートナーシップオーナーアカウント に固有のものです（他の REST API キー は使用できません）。

パートナーシップ API キーを REST API (v2) のエンドポイントへの呼び出しで使用する場合は、 管理者ユーザーの API キー 、 管理者ユーザーの API キーとパートナーシップ を参照してください。

パートナーIDの検索

パートナーシップ API では、パートナーシップに固有の Partner ID を提供して認証することも必要です。これは、パートナーシップオーナーアカウントの アカウントID とは異なります。

パートナーIDを取得するには、 パートナー管理コンソール にアクセスして、お客様のURLに記載されているパートナーID番号を取得してください。

https://partner-admin-console.newrelic.com/accounts/​$ACCOUNT_ID/admin_console/partnerships/$PARTNER_ID

パートナーAPIのベースURLの一部にパートナーIDを含める必要があります。

https://rpm.newrelic.com/api/v2/partners/PARTNER_ID

/accounts
/accounts/ACCOUNT_ID
/accounts/ACCOUNT_ID/users
/accounts/ACCOUNT_ID/users/USER_ID
/accounts/ACCOUNT_ID/subscriptions
/accounts/ACCOUNT_ID/subscriptions/SUBSCRIPTION_ID

https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

APIコールの認証を行う

APIコールを行う際にPartner APIを認証するため。

1. x-api-key というラベルのついたリクエストヘッダーを追加し、その値に Partner API key を設定します。
2. パートナーID をリクエストURIの指定された箇所に含めてください。

New Relicのアカウントを管理するパートナー様への注意事項

顧客の New Relic アカウントを管理するパートナーにとって、アカウントレベルのすべてのインタラクションの最初の API 呼び出しは、"create account です。" この呼び出しは、新しく作成されたアカウントの xml レコードを返します。このレコードの一部は、 account_id です。Partnership API の他のすべての呼び出しは、パラメータとして account_id を必要とします。パートナーは、返されたxml抽出物を解析して、 account_id を保存し、それをユーザのパートナーアカウントレコードに関連付けるための準備を行う必要があります。

エラー

New Relic では、API リクエストの成功または失敗を示すために、従来の HTTP 応答コードを使用しています。一般的に、 2xx の範囲のコードは成功を示し、 4xx の範囲のコードは、提供された情報に起因するエラーを示します (例えば、必須パラメータが欠けていたなど)。