現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
デベロッパー カテゴリは、類似した特性を持つデベロッパーまたは企業のグループです。特定のカテゴリで動作するように収益化を構成できます。たとえば、収益分配用のアプリを開発するすべてのデベロッパーに適用される料金プランを作成するには、「revenue_sharing」というデベロッパー カテゴリを作成し、このカテゴリにデベロッパーを追加します。デベロッパー カテゴリを使用した料金プランの作成について詳しくは、料金プランを作成するをご覧ください。
[Developer Categories] ページについて
以降のセクションで説明するように、Edge UI または Classic Edge UI を使用して [Developer Categories] ページにアクセスします。
Edge UI
[Develop Categories] ページにアクセスするには:
- apigee.com/edge にログインします。
- 左側のナビゲーション バーで [Publish] > [Monetization] > [Developer Categories] を選択します。
[Developer Categories] ページが表示されます。
図でハイライト表示されているように、[Developer Categories] ページでは次のことができます。
従来の Edge(Private Cloud)
Classic Edge UI を使用して [Develop Categories] ページにアクセスするには:
http://ms-ip:9000
にログインします。ここで、ms-ip は Management Server ノードの IP アドレスまたは DNS 名です。- 上部のナビゲーション バーで [Publish] > [Developer Categories] を選択します。
[Developer Categories] ページが表示されます。
[デベロッパー カテゴリ] ページでは次のことができます。
デベロッパー カテゴリを追加する
UI を使用してデベロッパー カテゴリを追加するには:
- [Develop Categories] ページにアクセスします。
- [+ Developer Category] をクリックします。
- 新しいカテゴリの名前と簡単な説明を入力します。
- [Create Developer Category](デベロッパー カテゴリを作成)をクリックします。
デベロッパー カテゴリに会社を追加する
会社をデベロッパー カテゴリに追加します。会社は 1 つのデベロッパー カテゴリにのみ所属できます。
会社をデベロッパー カテゴリに追加するには:
- 上部のナビゲーション バーで [Publish] > [Companies] を選択します。
- デベロッパー カテゴリに追加する会社を選択します。
- 会社ページで [Edit] をクリックします。
- 会社の [Developer Category](デベロッパー カテゴリ)を選択します。
- [保存] をクリックします。
デベロッパー カテゴリの編集
UI を使用してデベロッパー カテゴリを編集するには:
- [Develop Categories] ページにアクセスします。
- 編集するデベロッパー カテゴリにカーソルを合わせて、 をクリックします。
- デベロッパーのカテゴリを入力します。
- [Update Developer Category](デベロッパー カテゴリを更新)をクリックします。
デベロッパー カテゴリを削除する
UI を使用してデベロッパー カテゴリを削除するには:
- [Develop Categories] ページにアクセスします。
- 編集するデベロッパー カテゴリにカーソルを合わせます。
- [] をクリックします。
- [Delete] をクリックして削除操作を確定します。
API でデベロッパー カテゴリを管理する
以降のセクションで説明するように、API を使用してデベロッパー カテゴリを管理します。
API を使用してデベロッパー カテゴリを追加する
/mint/organizations/{org_name}/developer-categories
に POST リクエストを発行して、デベロッパー カテゴリを追加します。
リクエストを発行するときに、ペイロードにカテゴリ name
と description
を指定します。例:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Content-Type:application/json" \ -d '{ "name": "Gold", "description": "Gold membership" }' \ -u email:password
レスポンスは次のようになります。
{ "description" : "Gold membership", "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0", "name" : "Gold" }
API を使用してデベロッパーまたは会社をデベロッパー カテゴリに追加する
会社またはデベロッパーを追加または編集するときに、次のリソースに POST リクエストを発行して、デベロッパーまたは会社をデベロッパー カテゴリに追加します。
- /organizations/{org_name}/companies
- /organizations/{org_name}/developers
会社またはデベロッパーを編集するときに、デベロッパーまたは会社をデベロッパー カテゴリに追加するには、それぞれ次のリソースに PUT リクエストを発行します。
- /organizations/{org_name}/companies/{company_id}
- /organizations/{org_name}/developers/{developer_id}
会社やデベロッパーは、1 つのデベロッパー カテゴリにのみ所属できます。
リクエスト本文の属性として MINT_DEVELOPER_CATEGORY
を指定し、値としてカテゴリの内部 ID を指定します。たとえば、次のリクエストでは、既存のデベロッパーを、ID が aa6f960a-d9fd-416e-be39-c071418aabd0
の「Gold」カテゴリという名前のデベロッパー カテゴリに追加します。
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \ -H "Content-Type: application/json" \ -d '{ "email" : "developer@apigee.com", "developerId" : "K4jW2QLjZ1h8GFA8", "firstName" : "Dev", "lastName" : "One", "userName" : "devone", "attributes" : [ { "name" : "MINT_REGISTRATION_ID", "value" : "dev1" }, { "name" : "MINT_DEVELOPER_LEGAL_NAME", "value" : "DEV ONE" }, { "name" : "MINT_DEVELOPER_TYPE", "value" : "TRUSTED" }, { "name" : "MINT_BILLING_TYPE", "value" : "PREPAID" }, { "name" : "MINT_IS_BROKER", "value" : "TRUE" }, { "name" : "MINT_DEVELOPER_CATEGORY", "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0" }, { "name" : "MINT_DEVELOPER_ADDRESS", "value" : "{ "address1": "Dev One Address", "city": "Pleasanton", "country": "US", "isPrimary": "true", "state": "CA", "zip": "94588" }" } }' \ -u email:password
API を使用してデベロッパー カテゴリを表示する
組織内の特定のデベロッパー カテゴリまたはすべてのデベロッパー カテゴリを表示する。
特定のデベロッパー カテゴリを表示するには、GET リクエストを /mint/organizations/{org_name}/developer-categories/{category_id}
に送信します。ここで、{category_id}
はデベロッパー カテゴリの ID です(この ID は、デベロッパー カテゴリを追加するとレスポンスで返されます)。例:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
組織のすべての API デベロッパー カテゴリを表示するには、/mint/organizations/{org_id}/developer-categories
に GET リクエストを発行します。例:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Accept:application/json" \ -u email:password
API を使用したデベロッパー カテゴリの編集
デベロッパー カテゴリを編集するには、PUT リクエストを /mint/organizations/{org_name}/developer-categories/{category_id}
に発行します。ここで、{category_id}
は更新するカテゴリの ID です。リクエストの本文で、更新した設定とデベロッパー カテゴリの ID を指定する必要があります。たとえば、次のリクエストはデベロッパー カテゴリの説明を編集します。
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Content-Type: application/json" \ -d '{ "id": "aa6f960a-d9fd-416e-be39-c071418aabd0", "description": "Premium membership" }' \ -u email:password
API を使用してデベロッパー カテゴリを削除する
デベロッパー カテゴリを削除するには、/mint/organizations/{org_name}/developer-categories/{category_id}
に DELETE リクエストを発行します。ここで、{category_id}
は、削除するデベロッパー カテゴリの ID です。次に例を示します。
curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
API のデベロッパー カテゴリの設定プロパティ
次の表は、API を使用して設定できる構成プロパティをまとめたものです。
名前 | 説明 | デフォルト | 必須 / 任意 |
---|---|---|---|
name |
プロパティ名。MINT_DEVELOPER_CATEGORY に設定します。 |
なし | ○ |
value |
デベロッパーが追加されるデベロッパー カテゴリの ID。 |
なし | はい。デベロッパー カテゴリを設定するには、必要です。 |