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

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します。 info

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

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

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

UI を使用してアプリ デベロッパーを管理する

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

UI を使用して企業を管理する

次のセクションの説明に従って、企業を作成、管理、有効化します。

[Companies] ページを確認する

次の手順に従って [Companies] ページにアクセスします。

会社を追加する

会社を追加するには:

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

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

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

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

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

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

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

1. [Company] ページにアクセスします。
2. 有効にする会社にカーソルを合わせ、操作メニューの を有効にします。
   トグルを無効にすると、会社が無効になります。

会社を編集する

会社を編集するには:

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

会社を削除する

会社を削除するには:

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

API を使用して企業とデベロッパーを管理する

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

API を使用して企業とデベロッパーを作成、更新する

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

• 会社を作成する
• デベロッパーを作成する
  注: カスタム属性を渡してデベロッパーを作成するときに、収益化情報を構成します。
• 会社のデベロッパーを追加または更新する
  注: 必要に応じて、デベロッパーにロールを割り当てることができます。デベロッパー ロールのリストを取得するには、デベロッパー ロールを取得するをご覧ください。
• すべてのデベロッパーまたは 1 人のデベロッパーの収益化構成を一覧表示する all developers or for a single developer
  Note: デベロッパーの作成または更新時にカスタム属性を渡して、収益化情報を定義します。 creating or updating a developer. 標準（非収益化）API を使用して設定された収益化カスタム属性を表示して、 すべてのデベロッパーまたは 1 人のデベロッパーを一覧表示できます。

API を使用してデベロッパー ロールを管理する

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

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

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

$ 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 リクエストを発行します。リクエストを行う際は、 デベロッパーの識別情報をクエリ パラメータとして指定する必要があります。次に例を示します。

$ 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 を使用して実行できるデベロッパー固有のタスクを示します。また、これらのタスクの実行方法の詳細な手順を確認できる場所も示します。