Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Managing app developers

Edge provides many benefits that are completely dependent on knowing who's calling your APIs. For example, API security, traffic management, and a fair amount of analytics data depend on knowing who's calling. And how does Edge know who's calling your APIs? By reading unique information in each API call, such as a user ID, an API key, or an OAuth token. That unique information locks or unlock the functionality you build into your API proxies, giving you full control over API access and behavior.

That's why app developers need to register to use your APIs. Once added, developers register their apps, choose the APIs they want to use, and receive the unique API credentials (consumer keys and secrets) needed to access your APIs.

This topic covers how to register and manage your app developers. (App registration is a separate process covered in Register apps and manage API keys).

API security, traffic management, and developer/app analytics are dependent on proper API proxy configuration. For example, you need to add the right policies to your proxies, such as API key validation or OAuth access token verification, quota enforcement, and rate limiting. Those policies identify which specific developer and app is making the call, which in turn enables API security enforcement, developer- or app-specific traffic management, API analytics capture, and other functionality. Technically, you could develop open APIs that don't check for API keys or access tokens, which means you wouldn't really need to register developers. But we strongly discourage this, because you lose API security, lose control over performance (through good traffic management), lose out on analytics data, and miss out on other major benefits that Edge provides.

You can register developers in a number of ways:

  • If you have a paid Edge account, develpers can self-register through a Developer Services portal. See Add and manage user accounts.
  • Edge 管理 API を使用してデベロッパを登録するフォームにアクセスする。詳細については、「Edge management API to Publish APIs」を参照してください。
  • As an API provider, your administrative users can add developers in the Edge management UI, described below.

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

You can access the Drupal-based Developer Services portal from this page by clicking Dev Portal. If you have not created a developer services portal and wish to, click Submit a request in the dialog box to be redirected to a page that describes how to set up a developer portal.

If you use the Drupal-based Developer Services portal, Apigee recommends that you log into the portal as a portal administrator to manually create, edit, and delete developers on the portal, not in the Edge UI. When you add a developer through the administrator interface on the portal, you can set the developer's password for the portal and trigger an automated email message sent to the developer. Also, any changes made to the developer's account on the portal are automatically sent to Edge. When adding or modifying a developer through Edge, no email is sent to the developer and you cannot set the password for the developer on the portal. Therefore, the developer must reset their password on the portal before they can log into the portal. For more information, see Add and manage user accounts.

Adding developers using the Edge management UI

Developer Services ポータルを使用する場合、Apigee は、Edge 管理 UI ではなくポータル上でデベロッパを作成、編集、削除することをお勧めします。詳細については、「ユーザーアカウントの追加と管理」を参照してください。

  1. Log into the Edge management UI at https://enterprise.apigee.com.
  2. メニューで、「Publish」>「Developers」の順にクリックします。
  3. 追加の「(+) Developer」ボタンをクリックします。
  4. デベロッパの名を入力します。
  5. デベロッパの姓を入力します。
  6. デベロッパのメールを入力します。これは、デベロッパにキーや通知を送信するときのメールアドレスです。
  7. Add any custom attributes for the developer. You can add up to 18 of them. For each custom attribute:
    • 「(+) Add Custom Attribute」をクリックします。
    • 属性の名前と値を入力します。
    マネタイズ属性の定義については、「マネタイズ属性の定義」を参照してください。
  8. 「Save」をクリックします。
  9. Developer Services ポータルを使用している場合は、以下の説明に従って、ポータルを Edge への変更と同期させます。新しいデベロッパは、初めてポータルにログインしたとき、ポータル上でパスワード回復プロセスを使用してポータルのパスワードを設定する必要があります。

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

Developer Services ポータルを使用する場合、Apigee は、Edge 管理 UI ではなくポータル上でデベロッパを作成、編集、削除することをお勧めします。詳細については、「ユーザーアカウントの追加と管理」を参照してください。

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

    マネタイズ属性の定義については、「マネタイズ属性の定義」を参照してください。

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

Deactivating a developer

When you deactivate a developer, none of that developer's API keys can be used to make API calls to Edge. The developer can still log into the developer portal and create apps, but none of the corresponding keys will work. The developer's apps still retain their approved (or other) status, as do the API keys, even though they're not valid while the developer is inactive.

When a developer is inactive, and you view the Developer App Details page for each of the developer's apps in the management UI, the status label on the app and API keys appears in strikethrough text (Approved or Revoked); and if you mouse over the label, the tooltip says the developer is inactive. If you reactivate a developer, the strikethrough disappears, and approved apps and API keys are valid again.

If the developer is in multiple organizations, perform these steps in each organization.

Deactivate a developer in the management UI

  1. Go to Publish > Developers > [developer] > Edit.
  2. Click Deactivate in the Status field.
  3. 「Save」をクリックします。 

After deactivation, it may take a few minutes for the change to be updated on all message processors. Until then, some calls by the developer's app may continue to make it through successfully.

Deactivate a developer with the management API

See Set Developer Status to set the developer's status to inactive.

You can re-activate a developer by editing the developer in the management UI and clicking Activate, or by using the management API and setting the developer's status to active. Again, it may take a few minutes for the change to be recognized by all message processors.

Edge 管理 UI を使用してデベロッパを削除する

Developer Services ポータルを使用する場合、Apigee は、Edge 管理 UI ではなくポータル上でデベロッパを作成、編集、削除することをお勧めします。詳細については、「ユーザーアカウントの追加と管理」を参照してください。

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

ポータルを、Edge UI を使用して変更されたデベロッパと同期させる

If you are using a Developer Services portal to publish your APIs, changes made to developers through the Edge UI are not pushed down to the portal. Therefore, you must log into the portal as a portal administrator and synchronize the portal with Edge for those changes to appear on the portal.

Developer Services ポータルを使用する場合、Apigee は、Edge UI ではなくポータル上でデベロッパを作成、編集、削除することをお勧めします。詳細については、「ユーザーアカウントの追加と管理」を参照してください。

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

  1. Log into your portal as a user with admin or content creation privileges.
  2. Drupal の管理メニューで、「People」を選択します。
  3. ページの上部にある「Dev Portal Developer Sync」ボタンを選択して、Edge 上で追加されたデベロッパをプルします。

デベロッパを会社にグループ化する

With monetization, a company is a collection of developers managed as a single entity. A company can be any grouping that is appropriate to your organization such as business unit, product line, or division. Grouping developers into companies is useful when your need to have multiple developers associated under a single corporate entity. For example, you may need to set up different companies for billing purposes. However, developers in your organization don't need to be associated with a company. Note that a developer is always a single entity, uniquely identified by the email element. If a developer is part of a company you'll see the Company name on the Developers page. 

For more information about managing companies and developers for monetization, see Manage companies and developers. To use the Edge management API, use the Companies API to set up a company group and the Company Developers API to add developers to the company. 

マネタイズ属性の定義

組織でデベロッパを追加または編集するとき、次の表で示されているマネタイズ属性をカスタム属性として 1 つ以上定義できます。

料金プランに加入するために、デベロッパが会社を使用してグループ化されていない場合、デベロッパに対して次のマネタイズ属性を定義する必要があります: MINT_DEVELOPER_ADDRESSMINT_DEVELOPER_LEGAL_NAME
Name 説明
MINT_APPROX_TAX_RATE デベロッパの概算の税率。
MINT_BILLING_TYPE

Payment model used for billing. For more information, see Understanding billing types.

The value can be one of the following:

  • 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 デベロッパの追加先にするデベロッパカテゴリ。デベロッパカテゴリは、同様の特性を持つデベロッパまたは会社のグループです。詳細については、「Manage developer categories」を参照してください。
MINT_DEVELOPER_LEGAL_NAME すべてのレポートで使用されるデベロッパの実名。
メモ: この属性は、デベロッパが会社を使用してグループ化されておらず、公開された料金プランに加入する場合に必須です。
MINT_DEVELOPER_PHONE デベロッパの電話番号。
MINT_DEVELOPER_TYPE デベロッパタイプ。有効な値には、次が含まれます: TRUSTED または UNTRUSTED
MINT_HAS_SELF_BILLING 自己請求書が有効になっているかどうかを指定するフラグ。有効 (true) になっている場合、マネタイズは、レベニューシェア計算書ではなく自己請求書を生成します。自己請求書は、デベロッパによる金額を詳述する財務ドキュメントです。デベロッパの代理である API Provider への請求書としての役割を果たします。
MINT_IS_BROKER 収益が正味に基づいているかどうかを指定するフラグ。
MINT_REGISTRATION_ID すべてのレポートで使用されるデベロッパの登録 ID。
MINT_SUPPORTED_CURRENCY またはデベロッパが使用する「基準」または会計通貨の ISO 4217 コード (米国ドルの場合は USD など) を指定します。
MINT_TAX_EXEMPT_AUTH_NO 政府税額控除番号 (該当する場合)。

 

Help or comments?