アプリ デベロッパーの管理

Edge を使うと、API の呼び出し元を知る必要は完全になくなります。たとえば、API セキュリティ、トラフィック管理、相当量の分析データは、呼び出し元が誰かによって決まります。どのようにして Edge が API の呼び出し元を特定しているかというと、ユーザー ID、API キー、OAuth トークンなど、各 API 呼び出しに固有の情報を読み取って行っています。その固有の情報を使って、API プロキシに組み込んだ機能をロックまたはロック解除して、API へのアクセスと API の動作を完全に制御できるようにしています。

そのため、アプリ デベロッパーは API を使用するために登録が必要となります。登録されると、デベロッパーはアプリを登録し、使用する API を選択し、API へのアクセスに必要な固有の API 認証情報(コンシューマ キーとコンシューマ シークレット)を受け取ります。

このトピックでは、アプリ デベロッパーの登録と管理について説明します(アプリ登録の手順は、アプリの登録と API キーの管理で別途説明します)。

以下の方法でデベロッパーを登録できます。

  • Edge の有料アカウントをお持ちの場合は、Developer Services ポータルを使ってご自分で登録していただけます。ユーザー アカウントの追加と管理をご覧ください。
  • Edge 管理 API を使用するフォームにアクセスして、デベロッパーを登録します。Edge 管理 API を使用して API を公開するをご覧ください。
  • 以下のように、API プロバイダとして、管理ユーザーが Edge 管理 UI を使ってデベロッパーを追加できます。

Edge 管理 UI で、[Publish] > [Developers] を選択して [Developers] ページを開きます。作成したアプリと、デベロッパーに割り当てられたキーが表示されます。このページからは、デベロッパーの情報を管理したり、デベロッパーを組織から削除したりできます。

このページから [Dev Portal] をクリックして、Drupal ベースの Developer Services ポータルにアクセスできます。Developer Services ポータルを作成していない場合は、ダイアログ ボックスで [Submit a request] をクリックすると、デベロッパー ポータルの設定方法を説明するページに移動します。

Edge 管理 UI を使ってデベロッパーを追加する

  1. Edge 管理 UI(https://enterprise.apigee.com)にログインします。
  2. メニューで [Publish] > [Developers] をクリックします。
  3. [(+) Developer] をクリックします。
  4. デベロッパーの名前(名)を入力します。
  5. デベロッパーの名前(姓)を入力します。
  6. デベロッパーのメールアドレスを入力します。デベロッパーにキーや通知を送信するときのメールアドレスです。
  7. 必要に応じて、デベロッパーのカスタム属性を追加します。最大 18 個まで追加できます。1 つのカスタム属性ごとに、次の操作をします。
    • [(+) Add Custom Attribute] をクリックします。
    • 属性の名前と値を入力します。
    収益化属性の定義については、収益化属性の定義をご覧ください。
  8. [Save] を選択します。
  9. Developer Services ポータルを使用している場合は、以下の説明に従って、ポータルを Edge への変更と同期させます。新規のデベロッパーは、初めてポータルにログインしたとき、ポータル上のパスワード回復手順でポータルのパスワードを設定する必要があります。

Edge 管理 UI を使用してデベロッパーを編集する

  1. Edge 管理 UI(https://enterprise.apigee.com)にログインします。
  2. メニューで [Publish] > [Developers] をクリックします。
  3. [Developers] ページ内で、デベロッパーのエントリをクリックします。
  4. [Edit] をクリックします。
  5. 必要に応じて、デベロッパーの名前(姓、名)を編集します。
  6. 必要に応じて、カスタム属性を追加または削除します。

    収益化属性の定義については、収益化属性の定義をご覧ください。

  7. [Save] を選択します。
  8. Developer Services ポータルを使用している場合は、以下の説明に従って、ポータルを Edge への変更と同期させます。

Core Persistence Services の最小限のキャッシュ: Core Persistence Services(CPS)を有効にしている組織では、以下のエンティティが、アクセス後最低 180 秒間、Edge によってキャッシュに保持されます。

  • OAuth アクセス トークン。つまり、OAuth v2 ポリシーの ExpiresIn 要素を使っても、アクセス トークンを 180 秒未満のうちに期限切れにすることはできないということです。
  • Key Management Service(KMS)エンティティ(アプリ、デベロッパー、API プロダクト)
  • OAuth トークンと KMS エンティティのカスタム属性

デベロッパーを非アクティブにする

デベロッパーを非アクティブにすると、そのデベロッパーの API キーは、Edge への API 呼び出しに使えなくなります。デベロッパーは、引き続きデベロッパー ポータルへログインでき、アプリの作成もできますが、関連するキーは機能しません。デベロッパーのアプリは、デベロッパーが非アクティブの間は無効ですが、その承認(あるいはその他の)ステータスと API キーは維持されます。

デベロッパーが非アクティブになっているときに、管理 UI でデベロッパーのアプリの [Developer App Details] のページでは、アプリと API キーのステータス ラベルに取り消し線が引かれて表示されます([Approved] あるいは [Revoked])。ステータス ラベルにマウスカーソルを置くと、デベロッパーが非アクティブだというツールチップが表示されます。デベロッパーを再度アクティブにすると、取り消し線が消え、承認されたアプリと API キーが再び有効になります。

デベロッパーが複数の組織に属している場合、各組織についてこの手順を行います。

管理 UI でデベロッパーを非アクティブにする

  1. [Publish] > [Developers] > [developer] > [Edit] に移動します。
  2. [Status] フィールドの [Deactivate] をクリックします。
  3. [Save] をクリックします。

非アクティブにした後、すべてのメッセージ プロセッサに変更が反映されるまで数分かかることがあります。それまでは、デベロッパーのアプリへの呼び出しが引き続き成功する可能性があります。

管理 API を使ってデベロッパーを非アクティブにする

デベロッパーのステータスを inactive にするには、Set Developer Status をご覧ください。

管理者 UI でデベロッパーを編集し、[Activate] をクリックするか、管理 API でデベロッパーのステータスを active に設定して、デベロッパーを再度アクティブにできます。この場合も、変更がすべてのメッセージ プロセッサで認識されるまでに数分かかることがあります。

デベロッパーの削除

管理 UI でデベロッパーを削除する

  1. Edge 管理 UI(https://enterprise.apigee.com)にログインします。
  2. メニューで [Publish] > [Developers] をクリックします。
  3. デベロッパーの一覧で、削除するデベロッパーを探します。
  4. そのデベロッパーのアプリの数がゼロの場合、[Delete] ボタンが有効になります。
    • [Delete] ボタンを選択して、ユーザーを削除します。
    • デベロッパーを削除することを確認します。
  5. そのデベロッパーのアプリの数がゼロでない場合、[Delete] ボタンが無効になります。デベロッパーを削除するには、まず、そのデベロッパーに関連付けられているすべてのアプリを削除する必要があります。
    • [Developers] ページ内で、デベロッパーのエントリをクリックします。
    • デベロッパーのページの [Apps] で、アプリの名前を選択します。
    • アプリのページで [Delete] を選択して、削除を確認します。
    • デベロッパーのすべてのアプリを削除した後、デベロッパーを削除できます。
  6. Developer Services ポータルを使用している場合は、以下の説明に従って、ポータルを Edge への変更と同期させます。

管理 API でデベロッパーを削除する

デベロッパーの削除をご覧ください。

ポータルを Edge UI で変更されたデベロッパーと同期させる

API を公開するために Developer Services ポータルを使っている場合、Edge UI で行ったデベロッパーへの変更は、ポータルに反映されるわけではありません。したがって、変更をポータルに表示するには、ポータル管理者としてポータルにログインし、ポータルを Edge と同期する必要があります。

ポータルを Edge で追加したデベロッパーと同期させるには、次の手順を実行します。

  1. 管理者権限またはコンテンツ作成権限を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで [People] を選択します。
  3. ページの上部にある [Dev Portal Developer Sync] ボタンを選択して、Edge でのデベロッパーの追加を反映させます。

デベロッパーをまとめてカンパニーにする

収益化では、カンパニーは 1 つのエンティティとして管理されるデベロッパーの集まりです。カンパニーは、ビジネス単位、製品ライン、部門など、組織にとって適切な任意のグループにできます。デベロッパーをカンパニーにグループ化することは、複数のデベロッパーを 1 つの企業エンティティに関連付ける必要がある場合に便利です。たとえば、請求目的で別々のカンパニーを設定することが必要な場合があります。ただし、組織内のデベロッパーをカンパニーに関連付ける必要はありません。デベロッパーは常に単一のエンティティであり、email 要素で一意に識別されます。デベロッパーがカンパニーに属する場合、[Developers] ページに [Company] 名が表示されます。

収益化のためのカンパニーとデベロッパーの管理については、カンパニーとデベロッパーの管理をご覧ください。Edge 管理 API を使用するには、Companies API を使ってカンパニー グループを設定し、Company Developers API を使ってカンパニーにデベロッパーを追加します。

収益化属性の定義

組織にデベロッパーを追加または編集するとき、次の表の収益化属性をカスタム属性として 1 つ以上定義できます。

名前 説明
MINT_APPROX_TAX_RATE デベロッパーの概算の税率。小数点以上最大 3 桁、小数点以下 4 桁の小数で指定します。
MINT_BILLING_TYPE

請求に使用される支払モデル。詳細については、請求タイプについてをご覧ください。

次のいずれかの値です。

  • PREPAID - デベロッパーは API プロダクトの使用料を前払いする。所持金は、API プロダクトが使用されたときにデベロッパーの残高から差し引かれます。デベロッパーは、API プロダクトを購入するのに十分な前払残高を維持する必要があります。
  • POSTPAID - デベロッパーは API プロダクトの使用料を毎月(請求書で)請求されます。デベロッパーは、請求書に含まれるプランで設定された支払条件に基づいて、API プロダクトの使用料を支払います。
  • BOTH - デフォルトで PREPAID になります。
MINT_COMPANY_ID カンパニー ID(該当する場合)。詳細については、デベロッパーをカンパニーにグループ化するをご覧ください。
MINT_DEVELOPER_ADDRESS

デベロッパーのアドレス。次の名前と値のペアを指定します。


    {
       "address1":"Dev One Address",
       "city":"Pleasanton",
       "country":"US",
       "isPrimary":true,
       "state":"CA",
       "zip":"94588"
    }
    

: この属性は、デベロッパーがカンパニーでグループ化されておらず、公開された料金プランに加入したい場合に必要です。

MINT_DEVELOPER_CATEGORY デベロッパーの追加先となるデベロッパー カテゴリ。デベロッパー カテゴリは、類似の特性を持つデベロッパーまたはカンパニーのグループです。詳細については、デベロッパー カテゴリの管理をご覧ください。
MINT_DEVELOPER_LEGAL_NAME すべてのレポートで使用されるデベロッパーの実名。
: この属性は、デベロッパーがカンパニーでグループ化されておらず、公開された料金プランに加入したい場合に必要です。
MINT_DEVELOPER_PHONE デベロッパーの電話番号。
MINT_DEVELOPER_TYPE デベロッパー タイプ。有効な値は、TRUSTEDUNTRUSTED です。
MINT_HAS_SELF_BILLING 自己請求書が有効かどうかを指定するフラグ。有効(true)の場合、収益化が収益分配明細の代わりに自己請求書を生成します。自己請求書は、デベロッパーの請求額の詳細を示す財務書類です。デベロッパーに代わりに API プロバイダへ発行される請求書としての役割を果たします。
MINT_IS_BROKER 収益が純益に基づいているかどうかを指定するフラグ。
MINT_REGISTRATION_ID すべてのレポートで使用されるデベロッパーの登録 ID。
MINT_SUPPORTED_CURRENCY デベロッパーが使用する「基準」通貨または会計通貨を ISO 4217 コードで指定します(米国ドルならば USD など)。
MINT_TAX_EXEMPT_AUTH_NO 政府税額控除番号(該当する場合)。