Edge を使用した企業とデベロッパーの管理

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

収益化 API プログラムに参加する企業とデベロッパーをより細かく管理したい場合（テスト目的で社内企業とデベロッパーを作成するなど）は、管理 UI と API を使用して企業とデベロッパーを手動で作成できます。

企業とデベロッパーを手動で作成する必要があるかどうかを判断する主な考慮事項は、デベロッパーが管理 UI へのログイン、Edge 管理 API への呼び出しでの認証情報の送信、デベロッパー ポータルへのログインに認証情報を必要とするかどうかです。

• 収益化デベロッパーが Edge UI または API にアクセスするためにログイン認証情報を必要とする場合は、まず独自の Apigee 管理者アカウントが必要です。
• 認証情報を必要としないテスト デベロッパーを作成する場合（架空のテスト デベロッパーで API 呼び出しを行う場合など）は、Apigee アカウントは必要ありません。

UI を使用したアプリ デベロッパーの管理

アプリ デベロッパーの管理で説明されているように、Edge UI を使用してアプリ デベロッパーを作成、管理、有効にします。アプリ デベロッパーを作成したら、次のセクションで説明するように、企業に追加できます。

UI を使用した企業の管理

以下のセクションで説明するように、企業を作成、管理、有効にします。

[企業] ページの確認

下記の手順に沿って [企業] ページにアクセスします。

会社の追加

会社を追加するには:

1. [Companies] ページにアクセスします。
2. [+ 会社] をクリックします。
3. 会社の詳細を入力します。

   必須フィールドは以下のとおりです。

   • 会社名
   • 管理者（会社のメイン管理者であるユーザー）
   • 請求タイプ

   収益化の課金設定によっては、課金タイプがデフォルトで PREPAID または POSTPAID になることがあります。詳細については、API を使用して前払いと後払いの課金タイプを構成するをご覧ください。

4. 1 つ以上のデベロッパーを会社に追加します。
   1. [デベロッパー] セクションの [デベロッパーを追加] フィールドに文字列を入力すると、その文字列に一致するデベロッパーのリストが表示されます。
   2. プルダウン リストからデベロッパーを選択します。
   3. 会社にデベロッパーをさらに追加するには、この手順を繰り返します。
5. 1 つ以上のカスタム属性を追加します。
   1. [カスタム属性] セクションで [+ 新規] をクリックします。
   2. カスタム属性の名前と値を入力します。
   3. 会社にカスタム属性を追加するには、この手順を繰り返します。
6. [会社を作成] をクリックします。

会社の有効化と無効化

会社を有効または無効にするには:

1. [会社] ページにアクセスします。
2. 有効にする企業にカーソルを合わせて、操作メニューの を有効にします。
   スイッチをオフにして、会社を無効にします。

会社の編集

会社を編集するには:

1. [会社] ページにアクセスします。
2. 編集する企業にカーソルを合わせて、操作メニューの をクリックします。
3. 必要に応じて会社情報を更新します。
4. [会社を更新] をクリックして変更を保存します。

会社の削除

会社を削除するには:

1. [Companies] ページにアクセスします。
2. 削除する企業にカーソルを合わせ、アクション メニューの をクリックします。
3. [削除] をクリックして削除の操作を確定します。

API を使用した企業とデベロッパーの管理

API を使用して企業とデベロッパーを管理する方法については、以降のセクションで説明します。

API を使用した企業とデベロッパーの作成と更新

API Edge 管理 API を使用して企業とデベロッパーを管理するには、次の API セクションをご覧ください。

• 会社を作成する
• デベロッパーを作成する
  注: デベロッパーを作成するときに、カスタム属性を渡して収益化情報を構成します。
• 会社のデベロッパーを追加または更新する
  注: 必要に応じて、デベロッパーにロールを割り当てることができますが、必須ではありません。デベロッパー ロールのリストを取得するには、デベロッパー ロールの取得をご覧ください。
• すべてのデベロッパーまたは単一のデベロッパーの収益化構成を一覧表示します。
  注: デベロッパーの作成または更新時にカスタム属性を渡して、収益化情報を定義します。 標準（収益化以外の）API を使用して、収益化カスタム属性セットを表示し、すべてのデベロッパーまたは単一のデベロッパーを一覧表示できます。

API を使用したデベロッパー ロールの管理

ロールは、Monetization API を使用して作成できます。これにより、パートナーのロールを確立できます。たとえば、パートナーに管理者とアプリケーション デベロッパーのロールを確立できます。これらのロールは、特定のパートナー社員に割り当てることができます。

デベロッパー ロールを作成する

デベロッパー ロールを作成するには、organizations/{org_name}/developer-roles に POST リクエストを発行します。リクエストを行う際は、リクエスト本文でロールの名前と説明、組織の ID を指定する必要があります。次に例を示します。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}"
   }
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

デベロッパーのロール取得

デベロッパーのロールを取得するには、organizations/{org_id}/developer-roles に GET リクエストを送信します。次に例を示します。

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

レスポンスは次のようになります（レスポンスの一部のみが表示されています）。

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

API のデベロッパー ロールの構成設定

次のデベロッパー ロールの構成オプションが API に公開されます。

API を使用してデベロッパーの税率を取得する

デベロッパーの現在の税率を取得するには、organizations/{org_name}/tax-engine に GET リクエストを送信します。リクエストを行う際に、デベロッパーの ID をクエリ パラメータとして指定する必要があります。次に例を示します。

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

次のようなレスポンスが表示されます。

0.09

API を使用してデベロッパー固有のその他のタスクを実行する

料金プランの作成や通知条件の作成など、組織に対して実行できる収益化関連のタスクの多くは、個々のデベロッパーに対しても実行できます。たとえば、特定のデベロッパーの銀行口座を作成したり、特定のデベロッパーの収益レポートを生成したりできます。

次の表に、収益化 API を使用して実行できるデベロッパー固有のタスクを示します。この表には、これらのタスクの実行に関する詳細な手順を確認できる場所も記載されています。