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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

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

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

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

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

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

UI を使用した会社の管理

以降のセクションで説明するように、会社を作成、管理、有効化します。

[Companies] ページについて

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

エッジ

Edge UI を使用して [Companies] ページにアクセスするには:

  1. apigee.com/edge にログインします。
  2. 左側のナビゲーション バーで [Publish] > [Monetization] > [Companies] を選択します。

[Companies] ページが表示されます。

図でハイライト表示されているように、[Companies] ページでは次のことができます。

従来の Edge(Private Cloud)

Classic Edge UI を使用して [Companies] ページにアクセスするには:

  1. http://ms-ip:9000 にログインします。ここで、ms-ip は Management Server ノードの IP アドレスまたは DNS 名です。
  2. 上部のナビゲーション バーで [Publish] > [Companies] を選択します。

[Companies] ページが表示されます。

  • 現在の会社のリストを表示する
  • 会社の管理。具体的には、会社を追加、有効化、編集、削除します。
  • 接続されているデベロッパー ポータルを表示する(Drupal 7 のみ)

会社を追加する

会社を追加するには:

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

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

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

    Monetization の課金構成に応じて、請求タイプのデフォルトが PREPAID または POSTPAID になります。詳しくは、API を使用して前払いと後払いの請求タイプを構成するをご覧ください。

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

会社の有効化と無効化

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

  1. [Company](会社)ページにアクセスします。
  2. アクション メニューで を有効にする会社にカーソルを合わせ、有効にします。
    切り替えボタンをオフにして、会社を無効にします。

会社の編集

会社を編集するには:

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

会社を削除する

会社を削除するには:

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

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

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

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

API Edge Management 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 に公開されます。

名前 説明 デフォルト 必須 / 任意
name

デベロッパーのロールの名前。

なし
description

デベロッパーのロールの説明。

なし

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

デベロッパーの現在の税率を取得するには、GET リクエストを organizations/{org_name}/tax-engine に発行します。リクエストを行う際、クエリ パラメータとしてデベロッパーの 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 を使用してその他のデベロッパー固有のタスクを実行する

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

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

タスク 手順の場所
デベロッパーが同意した利用規約を表示する

API を使用してデベロッパーまたは企業が同意した利用規約を表示する

デベロッパーによって承認された API パッケージを表示する

API を使用してデベロッパーまたは企業が承認した API プロダクト バンドルを表示する

デベロッパー料金プランを作成する

料金プランの管理

デベロッパーが利用できる料金プランを表示する

料金プランページの使い方

特定のプロダクトを含む特定のデベロッパーで利用可能な料金プランを表示する

API プロダクトを含むデベロッパー向けの承認済みの料金プランを API で表示する

承認されたデベロッパー料金プランのみを表示する

API を使用してデベロッパーが承認したすべての料金プランを表示する

デベロッパーにクレジットを発行する

クレジットの発行

デベロッパーの利用限度額を設定する

API を使用した利用限度額の設定

デベロッパーの利用限度額を確認する

API を使用して利用限度額を取得する

デベロッパーの前払い残高を「チャージ」(金額を追加する)する

前払い残高を管理する

デベロッパーの前払い残高を確認する

デベロッパーの前払い残高を確認する

デベロッパーの通知条件を設定する

通知テンプレートを使用して通知を設定する

デベロッパー向けのレポート定義を作成して表示する

レポートを管理する