デベロッパー カテゴリを管理する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報

デベロッパー カテゴリは、類似の特性を持つデベロッパーまたはカンパニーのグループです。このカテゴリに応じて収益化を構成できます。たとえば、「revenue_sharing」というデベロッパー カテゴリを作成してデベロッパーを追加することで、収益分配アプリを開発するすべてのデベロッパーに適用される料金プランを作成できます。デベロッパー カテゴリを使用して料金プランを作成する方法については、料金プランを作成するをご覧ください。

[デベロッパーのカテゴリ] ページを確認する

以降のセクションの説明に従って、Edge UI または Classic Edge UI を使用して [Developer Categories] ページにアクセスします。

デベロッパー カテゴリを追加する

UI を使用してデベロッパー カテゴリを追加するには:

1. [カテゴリを作成] ページにアクセスします。
2. [+ Developer Category] をクリックします。
3. 新しいカテゴリの名前と簡単な説明を入力します。
4. [Create Developer Category]（デベロッパー カテゴリを作成）をクリックします。

デベロッパーのカテゴリに企業を追加する

デベロッパー カテゴリに会社を追加する。会社は 1 つのデベロッパー カテゴリにのみ所属できます。

デベロッパー カテゴリに企業を追加するには:

1. 上部のナビゲーション バーで [Publish] > [Companies] を選択します。
2. デベロッパー カテゴリに追加する会社を選択します。
3. 企業ページで [編集] をクリックします。
4. 会社の [デベロッパー カテゴリ] を選択します。
5. [保存] をクリックします。
   

デベロッパー カテゴリの編集

UI を使用してデベロッパー カテゴリを編集するには:

1. [カテゴリを作成] ページにアクセスします。
2. 編集するデベロッパー カテゴリにカーソルを合わせて、 をクリックします。
3. デベロッパー カテゴリを入力します。
4. [Update Developer Category]（デベロッパー カテゴリの更新）をクリックします。

デベロッパー カテゴリの削除

UI を使用してデベロッパー カテゴリを削除するには:

1. [カテゴリを作成] ページにアクセスします。
2. 編集するデベロッパー カテゴリにカーソルを合わせます。
3. [] をクリックします。
4. [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 を使用したデベロッパー カテゴリの表示

組織内の特定のデベロッパー カテゴリまたはすべてのデベロッパー カテゴリを表示します。

特定のデベロッパー カテゴリを表示するには、/mint/organizations/{org_name}/developer-categories/{category_id} に GET リクエストを送信します。ここで、{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

/mint/organizations/{org_id}/developer-categories に GET リクエストを発行して、組織のすべての API デベロッパー カテゴリを表示します。次に例を示します。

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \
  -H "Accept:application/json" \
  -u email:password

API を使用してデベロッパー カテゴリを編集する

/mint/organizations/{org_name}/developer-categories/{category_id} に PUT リクエストを発行してデベロッパー カテゴリを編集します。ここで、{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 を使用して設定できる構成プロパティを示します。