アプリデベロッパーを登録する

以降のセクションに示す方法で、アプリデベロッパーを登録して管理します（アプリの登録はこれとは別のプロセスです。これについてはアプリの登録と API キーの管理をご覧ください）。

はじめに

Edge は API 呼び出し元を認識する能力に強く依存する、多くの利点を提供します。たとえば API セキュリティ、トラフィック管理、かなりの量の分析データは、呼び出し元を認識することに依存しています。どのようにして Edge は API の呼び出し元を特定するのでしょうか。ユーザー ID、API キー、OAuth トークンなど、各 API 呼び出しに固有の情報を読み取るのです。その固有情報に基づいて、API プロキシに組み込んだ機能をロックまたはロック解除し、API へのアクセスと API の動作を完全に制御できます。

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

警告: API セキュリティ、トラフィック管理、デベロッパー / アプリ分析では、API プロキシを適切に構成する必要があります。たとえば、API キーの検証、OAuth アクセストークンの検証、割り当ての強制、レート制限などの適切なポリシーをプロキシに付加する必要があります。これらのポリシーで呼び出し元のデベロッパーとアプリを識別し、API セキュリティの適用、デベロッパーあるいはアプリ固有のトラフィック管理、API の分析など機能が有効になります。技術的には、API キーやアクセストークンを確認しないオープンな API を開発することもでき、その場合はデベロッパーの登録は必要ありません。しかしその場合、API セキュリティ、（適切なトラフィック管理による）パフォーマンス管理、分析データなどの重要な面で Edge の利点を活用できなくなるので、この方法はおすすめできません。

アプリデベロッパーの登録方法

アプリデベロッパーを登録するには、次のいずれかの方法に従います。

Edge の有料アカウントをお持ちの場合は、デベロッパーがデベロッパーポータルを使って自己登録できます。詳細については、デベロッパーポータルのタイプに応じて、次のいずれかのセクションをご覧ください。
- 統合ポータル: 統合ポータルでデベロッパーアカウントを作成する
- Drupal 8（ベータ版）: アプリデベロッパーアカウントを登録する
- Drupal 7: ユーザーアカウントを追加して管理する
管理者は、API を使用してアプリデベロッパーを登録できます。
デベロッパーポータル管理者は、次のセクションの説明に従ってポータル上でデベロッパーを直接管理できます。
- 統合ポータル: デベロッパーアカウントの管理の説明に従ってデベロッパーアカウントを管理します。
  このセクションの説明に従ってデベロッパーが統合ポータル上でアプリを作成した後は、デベロッパーアカウント情報が Edge に同期されて [Developers] ページに表示されます。デベロッパーのメールアドレスを使用して、デベロッパーアカウントにアプリデベロッパーレコードが関連付けられます。デベロッパーアカウントとアカウントに関連付けられたアプリ情報の保存場所について、詳しくはデベロッパーアカウントの格納場所をご覧ください。
- Drupal 8（ベータ版）: アプリデベロッパーによる Apigee Edge モジュールの操作方法
- Drupal 7: ユーザーアカウントを追加して管理する
組織管理者は、以降のセクションの説明に従って Edge UI または API を使用してデベロッパーを管理できます。

推奨: デベロッパーポータルでデベロッパーアカウントを管理する

Apigee では、デベロッパーポータルでデベロッパーアカウントを直接管理することをおすすめします。

統合ポータルを使用する場合、統合ポータルと Edge の間でデベロッパーアカウントを確実に同期状態に保つには、これが唯一の手段となります。

Drupal ベースのデベロッパーポータルを使用する場合、デベロッパーポータルでデベロッパーアカウントを直接管理することには、次の利点があります。

ポータル上の管理者インターフェースを使ってデベロッパーを追加するとき、そのデベロッパーのポータル用パスワードを設定することができ、デベロッパーに送られる自動メールメッセージをトリガーできます。
Edge を使用してデベロッパーを追加または変更する場合、デベロッパーにはメールが送信されず、ポータル上でのデベロッパーのパスワードも設定できません。したがって、デベロッパーがポータルにログインするには、その前にポータル上でパスワードをリセットする必要があります。
ポータル上でデベロッパーのアカウントを変更すると、それが自動的に Edge に送信されます。

Edge を使用して Drupal ベースのデベロッパーアカウントを管理することにした場合は、ポータルと Edge の間でアプリデベロッパーを同期する必要があります。

[Developers] ページの詳細

[Developers] ページにアクセスしてページの内容を調べるには、Edge UI と Classic Edge UI を使用できます。

Edge

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

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

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

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

デベロッパーを追加する
次のようなデベロッパーの詳細を表示して編集します。

カスタム属性を管理する
デベロッパーをアクティブ / 非アクティブにする

公開データをエクスポートする
デベロッパーを削除する
デベロッパーのリストを検索する

Classic Edge（Private Cloud）

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

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

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

デベロッパーのリストを表示する
デベロッパーを追加する
デベロッパーの詳細（カスタム属性を含む）を表示して編集し、デベロッパーをアクティブにする
公開データをエクスポートする
デベロッパーを削除する
デベロッパーのリストを検索する
接続されているデベロッパーポータルを表示する（Drupal 7 のみ）

デベロッパーを追加する

デベロッパーを追加するには:

[Developers] ページにアクセスします。
[+ Developer] をクリックします。
デベロッパーの名、姓、メールアドレス、ユーザー名などの詳細を入力します。
[Create] をクリックします。

デベロッパーの詳細を表示して編集する

デベロッパーの詳細を表示して編集できます。収益化が有効になっている組織の場合、収益化属性の構成で定義されている収益化カスタム属性を編集できます。

デベロッパーの詳細を表示して編集するには:

[Developers] ページにアクセスします。
表示して編集するデベロッパーの行をクリックして、デベロッパーの詳細を開きます。

[Details] セクションに次の情報が表示されます。必要に応じてデベロッパーの詳細を編集します。

詳細	説明
Details	デベロッパーの名、姓、ユーザー名、メールアドレス、登録のステータスと期間、デベロッパー ID。デベロッパーの詳細を編集するには、次のフィールド内をクリックします。 First Name Last Name Email Username 内容を変更した後、Enter キーを押して変更を確定します。
Custom attributes	このデベロッパーに定義されているカスタム属性。必要に応じてカスタム属性を構成します。詳しくは、以下をご覧ください。デベロッパーのカスタム属性を管理する収益化属性を構成する
アプリ	このデベロッパーによってすでに登録されたアプリ。アプリの登録をご覧ください。

[Status] フィールドでデベロッパーをアクティブまたは非アクティブにします。
詳しくは、デベロッパーをアクティブ / 非アクティブにするをご覧ください。

Apigee Edge for Public Cloud を使用すると、次に示すエンティティにアクセスした場合、Edge はアクセスしたエンティティを少なくとも 180 秒間キャッシュに保持します。

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

デベロッパーのカスタム属性を管理する

収益化属性を構成するで説明されている属性を含め、デベロッパーごとに最大 18 個のカスタム属性を追加できます。

統合デベロッパーポータルの場合、Edge 内で _apiportal カスタム属性を使用してデベロッパーの登録とポータルログインが追跡されます。詳しくは、Edge 内でデベロッパーの登録とログインが追跡される仕組みをご覧ください。

カスタム属性を管理するには:

[Developers] ページにアクセスします。
カスタム属性を管理するデベロッパーの行をクリックして、デベロッパーの詳細を開きます。
[Custom Attributes] セクションで [+] をクリックします。
属性の名前と値を入力します。
[] をクリックします。
カスタム属性を削除するには、削除する属性にカーソルを合わせ、表示されるアクションメニューでをクリックします。

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

ポータルで自己登録するアプリデベロッパーをデフォルトでアクティブ / 非アクティブのどちらにするかを、構成できます。

非アクティブになったデベロッパーは、依然としてデベロッパーポータルにログインしてアプリを作成できますが、対応する API キーはどれも機能しません。デベロッパーのアプリは、デベロッパーが非アクティブの間は無効ですが、その承認（あるいはその他の）ステータスと API キーは維持されます。

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

[Developers] ページにアクセスします。
アクティブまたは非アクティブにするデベロッパーの行をクリックして、デベロッパーの詳細を開きます。
[Details] セクションで、[Status] フィールドを必要に応じて [Active] または [Inactive] に設定します。
デベロッパーが複数の組織に属している場合は、上記の手順を繰り返します。

公開データをエクスポートする

次の公開データをコンマ区切り値（CSV）ファイルとしてエクスポートできます。

デベロッパーの詳細
デベロッパー、アプリケーション、API プロダクトの詳細

公開データをエクスポートするには:

[Developers] ページにアクセスします。
[Export CSV...] をクリックします。
プルダウンから [Developers] または [Developers, Apps, and Products] を選択します。

選択した公開データが CSV ファイルとしてダウンロードされます。

デベロッパーの削除

デベロッパーを削除するには:

[Developers] ページにアクセスします。
削除するデベロッパーの行にカーソルを合わせて、操作メニューを表示します。
[] をクリックします。
[Delete] をクリックして削除を確定します。

ポータルと Edge の間でアプリデベロッパーを同期する

Drupal ベースのデベロッパーポータルを使用して API を公開している場合、Edge を使用してアプリデベロッパーに対して行った変更はポータルに反映されません。これらの変更をポータル上に反映させるには、ポータル管理者としてポータルにログインし、ポータルを Edge と同期する必要があります。

Edge 上で定義されているアプリデベロッパーとの間でデベロッパーポータルを同期するには、以下のセクションをご覧ください。

Drupal 8（ベータ版）: Apigee Edge とのデベロッパーの同期
Drupal 7: ポータルと Edge の間でアプリデベロッパーを同期する

デベロッパーをカンパニーにグループ化する

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

収益化でのカンパニーとデベロッパーの管理については、企業とデベロッパーを管理するをご覧ください。

収益化属性を構成する

UI を使用してデベロッパーを編集する際、または API を使用してデベロッパーを作成あるいは編集する際は、次の表に定義されている収益化プロパティを構成できます。まず、組織プロファイルを編集するときに組織の収益化プロパティを構成します。

フィールド名	カスタム属性名	説明
Address	`MINT_DEVELOPER_ADDRESS`	デベロッパーの住所。住所（1 行目と 2 行目）、市区町村、都道府県、郵便番号、国のフィールドが含まれます。注: カンパニーにグループ化されていないデベロッパーが公開料金プランに加入するには、住所の入力が必須となります。
Billing Profile	`MINT_BILLING_PROFILE`	組織に適用される請求サイクル。有効な値は次のとおりです。 `PRORATED`: API を使用した当月の日数に基づいて請求が行われます。 `CALENDAR_MONTH`: 月単位で請求が行われます。
Billing Type	`MINT_BILLING_TYPE`	請求に使用されるデベロッパー支払いモデル。次のいずれかの値です。 PREPAID: デベロッパーは API プロダクトの使用料を前もって支払います。API プロダクトが使用されたときに、その使用料がデベロッパーの残高から差し引かれます。デベロッパーは、API プロダクトを購入するのに十分な前払残高を維持する必要があります。 POSTPAID: API プロダクトの使用料が毎月（請求書を通じて）デベロッパーに請求されます。デベロッパーは、請求書に含まれるプランで設定された支払い条件に基づいて、API プロダクトの使用料を支払います。 BOTH: 上記のいずれの課金タイプも使用できます。デフォルトは PREPAID です。 API を使用して前払いと後払いの課金タイプを構成するをご覧ください。
Category	`MINT_DEVELOPER_CATEGORY`	デベロッパーの追加先となるデベロッパーカテゴリ。デベロッパーカテゴリは、類似の特性を持つデベロッパーまたはカンパニーのグループです。詳細については、デベロッパーカテゴリの管理をご覧ください。
Company ID	`MINT_COMPANY_ID`	カンパニー ID（該当する場合）。詳細については、デベロッパーをカンパニーにグループ化するをご覧ください。
Developer Type	`MINT_DEVELOPER_TYPE`	Apigee では、このプロパティを使用していません。デベロッパーのタイプ。有効な値は、`TRUSTED` と `UNTRUSTED` です。
Is Broker	`MINT_IS_BROKER`	収益が純益に基づいているかどうかを指定するフラグ。
Legal name	`MINT_LEGAL_NAME`	すべてのレポートで使用されるデベロッパーの実名。注: この属性は、会社にグループ化されていないデベロッパーが公開料金プランに加入する場合に必須となります。
Self Billing	`MINT_HAS_SELF_BILLING`	自己請求書が有効かどうかを指定するフラグ。有効（`true`）になっている場合、マネタイズは、レベニューシェア計算書ではなく自己請求書を生成します。自己請求書は、デベロッパーの請求額の詳細を示す財務書類です。デベロッパーの代理である API Provider への請求書としての役割を果たします。
Tax Exempt Auth #	`MINT_TAX_EXEMPT_AUTH_NO`	政府税額控除番号（該当する場合）。
Tax Rate	`MINT_APPROX_TAX_RATE`	デベロッパーの税率（概算）。小数点以上最大 3 桁、小数点以下 4 桁の小数で指定します。

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

Developer API を使用してデベロッパーを管理できます。

API を使用してデベロッパーを作成、更新する際には、必要に応じて、収益化属性を構成するで説明されている収益化属性を構成できます。