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.

アプリ登録の構成

デベロッパは、Developer Services ポータル上の「My Apps」ページを使用して、アプリを登録します。デベロッパは、次のようにポータルのメインメニューから「My Apps」ページにアクセスします。

新しいアプリを登録するには、「My Apps」ページ上の「Add a new app」ボタンを選択します。

ポータルにデフォルトのアプリ登録フォームが表示されます。

デフォルトでは、デベロッパはアプリ名、コールバック URL、アプリを追加する API 製品 (product) のリストを指定するだけで済みます。

API プロバイダは、アプリ登録プロセスを完全に制御できます。例えば、次を構成できます。

  • ポータル上で使用可能な API 製品の指定
  • デフォルトの API 製品があるかどうか
  • コールバック URL が必要かどうか
  • API 製品に対して API キーが手動で承認されるか、自動的に承認されるか
  • アプリを登録するために「Add App」ページ上でその他の情報を必要とするかどうか

このトピックでは、ポータルのアプリ登録プロセスを構成する方法について説明します。ただし、このトピックでは、API 製品を作成する方法については説明していません。詳細については、次を参照してください。

デベロッパに割り当てられているロールに基づいて、デベロッパがアプリを作成、削除、または編集できないようにポータルを構成できます。例えば、デベロッパが登録されたら、すべてのデベロッパ用の単一のデフォルトアプリを作成するようにポータルを構成したとします。この場合、例えばデベロッパの料金体系やその他の特性に基づいて、一部のデベロッパにのみ、新しいアプリを追加することを許可できます。ロールと権限を使用して、どのデベロッパがアプリを作成、削除、編集できるかを制御できます。詳細については、「ユーザーアカウントの追加と管理」を参照してください。

ポータル上で使用可能な API 製品の指定

開発者がポータルにアクセスしたときに使用可能な API 製品を指定できる方法は 2 つあります。

API 製品作成時のアクセスレベルの指定

API 製品を作成するときは、次に示すように、製品のアクセスレベルオプションを指定します。

ポータル上では、デベロッパは「Public」のマークが付いた製品のみを使用できます。「Internal only」「Private」のマークが付いた API 製品も使用できますが、ポータルを通じてアクセスすることはできません。詳細については、「API 製品の作成」を参照してください。

ロールに基づいた API 製品へのアクセスの制限

Drupal モジュール API Product Role Access を有効にすることで、各 API 製品にアクセスできるロールを指定できます。

開発者ロールに基づいて API 製品へのアクセスを制限するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. デベロッパポータルのロールとユーザー割り当てを確認します。
    • Drupal の管理メニューで、「People」 > 「Permissions」 > 「Roles」の順に選択し、必要に応じて、開発者のロールや権限を追加または編集します。
    • Drupal の管理メニューで、「People」を選択し、必要に応じて、ユーザーやロール割り当てを編集します。
  3. Drupal の管理メニューで、「Configuration」 > 「Dev Portal」 > 「API Product Role Access」を選択します。
  4. 各 API 製品にアクセスできるようにするロールを選択します。
  5. 「Save configuration」 をクリックします。

デベロッパが API 製品をアプリに関連付ける方法の構成

新しいアプリを登録する場合、デベロッパは、「My Apps」ページ上の「Add a new app」ボタンを選択して、「Add App」フォームを開きます。

ポータルを構成する方法に基づいて、デベロッパはアプリ登録時に、アプリに関連付ける API 製品を 1 つ以上選択できます。また、すべてのアプリに割り当てるデフォルトの製品を指定することもできます。 

ポータル上では、アプリの登録時に API 製品の選択を制御する次の構成オプションを使用できます。

  • Do not associate apps with any API Product
  • Associate all apps with one or more Default API Products (configured below)。デベロッパは、アプリを他のどの API 製品にも追加できません。
  • Allow selection of a single API product, but do not require it
  • Require selection of a single API product
  • Allow selection of multiple API Products, but do not require any
  • Allow selection of multiple API Products, and require at least one

1 つ目を除くどのオプションも、すべてのアプリに追加するデフォルトの API 製品を指定できます (省略可能)。複数の API 製品を選択することをサポートしているオプションを選択した場合は、複数のデフォルトを指定できます。

デベロッパが API 製品を選択するために使用するフォームに表示される HTML 要素を制御することもできます。オプションには、次が含まれます。

  • ドロップダウンリスト。
  • チェックボックスまたはラジオボタン。デベロッパが API 製品を複数選択できるときはチェックボックスが表示され、デベロッパが API 製品を 1 つしか選択できないときはラジオボタンが表示されます。

API 製品の選択用のオプションを設定するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Select Configuration > Dev Portal Settings >  Application Attributes in the Drupal administration menu.
  3. On the Application Settings page, expand the API Product settings area.
  4. 「API Product Handling」で、API 製品の選択を制御するオプションを選択します。
  5. オプション「Associate all apps with one or more Default API Products (configured below)」を指定した場合は、「Default API Product」で、デフォルトの製品を設定します。
  6. 「API Product Widget」で、開発者が API 製品を選択するために使用する HTML 要素を選択します。
  7. 構成を保存します。

コールバック URL の処理を構成する

If one or more of your API proxies uses "three-legged OAuth" (OAuth's authorization code grant type), developers need to specify a callback URL when they register their apps. The callback URL points to an external site, such as https://twitter.com. When the app requires user credentials, it doesn't ask for a username and password. Instead, it forwards the end user to the callback URL site, where they log in, which allows the app to get an OAuth access token to use in place of their username and password.

コールバック URL を構成すると、アプリのデベロッパに、Twitter、Facebook、Google など、エンドユーザーをログインすべき特定のサイトに送る柔軟性が提供されます。

ポータル上でコールバック URL の要件を構成できます。例えば、製品内の API プロキシの 1 つ以上が three-legged OAuth を使用している場合は、OAuth プロキシでコールバック URL を使用できるように、すべてのデベロッパアプリについてコールバック URL を必要とすることが最善の場合があります。

API 製品の選択用のコールバック URL を制御するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Select Configuration > Dev Portal Settings >  Application Attributes in the Drupal administration menu.
  3. On the Application Settings page, expand the Callback URL settings area.
  4. 「Callback URL Handling」で、次のいずれかのオプションを選択します。
    • Callback URL is required for all developer apps
    • Callback URL is optional for all developer apps
    • Callback URL is neither required nor displayed
  5. 構成を保存します。

アプリの使用状況の分析を表示する

ポータルは、アプリの使用状況に関する分析情報を表示できます。分析の表示が有効になっている場合、アプリの開発者は、各アプリについて「My Apps」ページ上で分析を確認できます。例えば、開発者はアプリについて次のような分析を表示できます。

  • Throughput
  • Max Response Time
  • Min response time
  • Message count
  • Error Count

ポータル上で分析を有効にするには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Select Configuration > Dev Portal >  Application Settings in the Drupal administration menu.
  3. 「Application settings」ページで、「App Performance settings」領域を展開します。
  4. 「Show Developer App analytics tab」チェックボックスを選択します。
  5. 「Test」または「Production」「Environment to query for analytics data」で選択します。公開されているポータルの場合、通常は「Production」を選択します。
  6. 構成を保存します。

アプリについてポータル上に分析を表示するには、次の手順に従います。

  1. 「My Apps」ページで、アプリ名を選択します。
  2. アプリの「Analytics」リンクを選択します。
  3. 次のように、表示する分析のタイプと日付範囲を選択します。
  4. 次のように、選択した情報が表示されます。

When a developer app makes an API call with an API key or OAuth token, associations are made in analytics and performance data is collected. However, if an API proxy is open and doesn't require an API key, Edge has no way of knowing if there is a developer, developer app, or product associated with the API call. In this case, no performance data will be available.

API 製品の API キーを手動で承認する、または取り消す

デベロッパが API 製品をアプリに追加し、アプリを登録すると、ポータルからデベロッパにそのアプリの API キーが返されます。デベロッパは、この API キーを使用して、アプリに関連付けられている API 製品でバンドルされている API プロキシにアクセスします。

API 製品を作成するときは、API 製品ごとに次のようにキー承認プロセスを制御します。

承認プロセスは、次のようにすることができます。

  • Automatic - デベロッパがアプリを登録すると、ポータルから API 製品用の承認された API キーが返されます。後で、自働的に承認されたキーを取り消すことができます。
  • Manual - デベロッパがアプリを登録すると、ポータルから API キーが返されますが、そのキーは、「Manual」のキー承認を使用するどの API 製品用にもアクティブ化されていません。管理者は、デベロッパが API キーを使用して API 製品にアクセスできるように、Edge 管理 UI または API のいずれかで API キーを手動で承認する必要があります。後で、手動で承認されたキーを取り消すことができます。

詳細については、「API 製品 (product) の作成」を参照してください。

ポータルで、デベロッパは、API 製品をアプリに複数追加できる場合、「Automatic」のキー承認の製品と、「Manual」の製品を追加することがあります。デベロッパは、自働的に承認されたすべての API 製品用の返された API キーを使用できる一方、「Manual」の承認が必要な製品の最終承認を待つことになります。

ポータルは、アプリに関連付けられているすべての API 製品に使用できる API キーを 1 つ、アプリに割り当てます。API 製品は、承認保留になっている場合、その製品に使用するアプリのキーの承認を保留しています。

特定のアプリについての API 製品の一覧と、API 製品のキー承認のステータスを確認するには、デベロッパは、「My Apps」ページでアプリの名前を選択し、「Products」リンクを選択します。

この例では、Premium Weather API 製品は、「Manual」の承認を使用しており、管理者がキーを承認するのを待っています。Free API Product は、「Automatic」の承認を使用しており、アクセスするためのキーの使用が承認されています。

キーを手動で承認する、または取り消すには、次の手順に従います。

  1. Edge 管理 UI に、組織 (organization) の管理特権を持つユーザーとしてログインします。
  2. 右上隅のドロップダウンボックスで、「API Platform」を選択します。
  3. 「Publish」>「Developer apps」の順に選択して、デベロッパアプリの一覧を開きます。
  4. 「Pending」ボタンを選択して、保留中のキーリクエストがあるアプリの一覧を確認します。

  5. 承認するアプリ名を選択します。
  6. アプリ詳細ページの右上隅で、「Edit」ボタンを選択します。
  7. アプリについての API 製品の一覧の「Actions」で、次にようにします。
    • キーを承認するには、手動の承認が必要な各 API 製品の「Approve」ボタンを選択します。

    • 承認されたキーを取り消すには、「Actions」で、アクセスを取り消す API 製品の「Revoke」ボタンを選択します。

  8. アプリを保存します。これで、API キーが承認されました。

API 製品とアプリのキャッシュ処理を制御する

API 製品とデベロッパアプリに関する情報は、ポータルから離れた Apigee Edge 上に格納されます。これは、API 製品やアプリへの変更をポータルではなく Edge UI または API を使用して実行できることを意味します。例えば、バックエンド管理者が新しい API 製品を追加しても、ポータルがその情報で直ちに更新されるわけではありません。

ポータルが Edge のバックエンドと同期した状態を維持するには、ポータルキャッシュの更新を手動でトリガすることも、ポータルの cron ジョブが実行されるときにキャッシュを自動的に更新することもできます。また、両方を行うこともできます。例えば、5 分ごとや 10 分ごとなど、cron ジョブを頻繁に実行するように構成している場合は、API 製品とデベロッパアプリのキャッシュをそれほど頻繁に更新するオーバーヘッドを望まないことがあります。このような状況では、キャッシュ更新を手動でトリガできます。ただし、cron ジョブが 1 時間ごとや 2 時間ごとに実行される場合、これらのキャッシュを更新するのに必要な時間がそれほど問題にならないこともあります。

cron ジョブの頻度を設定するには、Drupal の管理メニューで、「Configuration」>「System」>「Cron」の順に選択します。

cron ジョブを手動でトリガするには、「Home」アイコン >「Run cron」の順に選択します。

デフォルトでは、ポータルは、cron が実行されるたびに API 製品とデベロッパアプリのキャッシュを再構築するように構成されています。

cron が実行されるたびに API 製品とデベロッパアプリのキャッシュを再構築するかどうかを指定するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. From the Drupal menu, select Configuration > Dev Portal Settings > Application Settings.
  3. 「Rebuild API Product and Developer App caches every time cron runs」をオンまたはオフにします。
  4. 設定を保存します。   

キャッシュを手動で更新するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal のメニューで、「Home」アイコン >「Flush all caches」の順に選択します。

アプリの登録に使用するフォームフィールドをカスタマイズする

デベロッパがアプリを登録するとき、ポータルにデフォルトのフォームが表示されます。

API プロバイダは、このフォームを、デベロッパに顧客 ID、アプリのターゲットプラットフォーム、その他の情報など、追加の情報の入力を促すように変更できます。ポータルには、このフォームに新しいフィールドを追加する機能が用意されています。これらのフィールドには、次の操作を行うことができます。

  • 必須または省略可能にする
  • テキストボックス、ラジオボタン、チェックボックスなど、さまざまな HTML 要素で表示する
  • フォーム上の「Callback URL」フィールドと「Product」フィールドの間の任意の場所に表示するように設定する

To learn how to customize the app registration form that is available from the developer portal, watch this video.

例えば、次のフォームには、顧客 ID 用の必須フィールドと、ターゲットプラットフォーム用の省略可能なフィールドが表示されています。

フォームに新しいフィールドを追加すると、デベロッパがフォームを送信したときに、そのフィールド値が、他のすべてのフィールドとともに Edge に自動的にアップロードされます。これは、Edge 上でそのフィールドを表示、変更したり、スクリプトから Edge 管理 API を使用してそのフィールドにアクセスしたりできることを意味します。

例えば、「Publish」>「Developer Apps」の順に移動し、アプリ名を選択して、Edge 管理 UI で新しいフォームフィールドを表示します。新しいフィールド値は、フィールドの内部名に対応する名前のページの「Custom Attributes」領域に表示されます。

フィールド値は、デベロッパの「My Apps」ページ上のアプリの「Details」領域にも表示されます。

デベロッパは、「My Apps」ページ上のアプリの「Edit」リンクを選択して値を編集することもできます。

次の手順では、管理者インターフェイスを使用してアプリ作成フォームを構成する方法について説明します。Drupal デベロッパは、「My Apps」ページを変更するなど、カスタムフックを使用して追加カスタマイズを実行できます。コードを通じて動作を変更する方法の詳細については、次のファイルにある、アプリの API の例を参照してください: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php

アプリ登録フォームにフィールドを追加するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. DevConnect App Attribute Management モジュールが有効になっていることを確認します。
  3. Drupal の管理メニューで、「Configuration」>「Dev Portal Settings」>「Dev Portal App Attributes」の順に選択します。
  4. ページの上部にある「Add Dev Portal App Attribute」を選択します。
  5. フィールドを構成します。例えば、上に示している「Customer ID」フィールドの場合は、次の設定を使用します。
    • Internal Name = cust_id。フィールド値を格納するために使用される変数の名前です。
    • Public Name = Customer ID
    • Description = 顧客 ID を入力します。
    • 「Require this attribute」のチェックボックスをオンにします。
    • 「Display this attribute」のチェックボックスをオンにします。
    • Widget = Text Box
    • 「Save」を選択して、「Dev Portal App Attributes」ページに戻ります。
  6. 「Save Changes」を選択します。
  7. Drupal のメニューの「Home」アイコン>「Flush all caches」を選択します。
    フォームに新しいフィールドが表示される前にブラウザキャッシュをクリアすることが必要な場合があります。

デベロッパがアプリのプラットフォームを指定するための省略可能なフィールドを追加するには、フィールド属性を次のように設定します。

  • Internal Name = intended_platforms
  • Public Name = Platforms
  • Description = アプリのプラットフォームを 1 つ以上指定します。
  • 「Require this attribute」のチェックボックスをオフにします。
  • 「Display this attribute」のチェックボックスをオンにします。
  • Widget = List of Checkboxes
  • 「Save」を選択して、「Dev Portal App Attributes」ページに戻ります。

フォーム上の属性の順序を変更するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Configuration」>「Dev Portal Settings」>「Dev Portal App Attributes」の順に選択します。
  3. 「Name」列の下のプラス (+) 記号を選択し、プロパティをフォーム内の表示する場所にドラッグします。
  4. 変更を保存します。

Help or comments?