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.

公開の概要


Publishing is the process of making your APIs available to app developers for consumption. Publishing APIs involves the following tasks, described in this topic:

  1. API をバンドルする Edge に API 製品 (product) を作成します。
  2. アプリデベロッパを Edge に登録します。
  3. Register developer apps on Edge.
  4. Provide documentation and community support for your APIs.

ビデオ: API 公開の概要については、この短いビデオをご覧ください。

ビデオ: ポータルで API を公開する方法については、この短いビデオをご覧ください。

タスク 1: Edge での API 製品の作成

The first task in publishing is to create an API product. An API product is a collection of API resources that are offered as a package to app developers for consumption. Create API products by using the Edge management API or UI. (See What is an API product? to learn more about API products.)

In this figure, the API consists of two products, each containing three API resources.

API プロバイダは、API と API 製品を構築し、アクセス制御、使用の制限、およびその他のビジネス要件を処理します。たとえば、次のような操作が可能です。

  • API リソースの読み取り専用アクセスが可能な API 製品をリリースする。
  • 低価格の 2 番目の API 製品 (無料バージョンと同じ API リソースの読み取り/書き込みアクセスが可能だが、1 日 1000 リクエストなど、アクセスの上限が低く抑えられている) をリリースする。
  • 高価格の 3 番目の API 製品 (同じ API リソースの読み取り/書き込みアクセスが可能で、アクセス上限が高く設定されている) をリリースする。

重要な点は、Edge では、API のビジネス要件に合わせて API 製品を柔軟に作成できることです。

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

タスク 2: Edge でのアプリデベロッパの登録

A developer creates the apps that consume your APIs. An app developer registers on Apigee Edge before they can register their app. When they register their app, they receive an API key that will give the app access to the API. 

アプリの登録プロセスを通して、API にアクセスできるユーザーを制御します。アプリデベロッパはいつでも削除できますが、削除したデベロッパに関連付けられているすべての API キーが無効になるため、そのデベロッパが API にアクセスすると拒否されます。

As an API provider, you decide how to register developers. For example, you can use a manual registration process that requires a potential developer to contact your organization to register. The potential developer must supply all necessary information, such as an email address, first and last name, and company name. If you approve the developer’s request, you can use the Edge management UI to manually register the developer. See Managing app developers for more.

Apigee では、デベロッパの登録プロセスを自動化できるツールが用意されています。例:

  • Apigee Edge 管理 API を使用して、登録機能を既存の Web サイトに登録する。Edge 管理 API は、デベロッパの登録プロセスのすべての処理を実行できる REST API です。詳細は、「Edge 管理 APIでの API の公開」を参照してください。
  • Apigee Developer Services ポータルを使用してデベロッパを登録する。ポータルには、デベロッパ登録のビルトインサポートだけでなく。API をサポートする多くの機能も用意されています。詳細については、「デベロッパポータルとは?」を参照してください。

Task 3: Register a developer app on Edge

アプリで API にアクセスするには、そのアプリを Edge に登録する必要がありますが、アプリを Edge に登録できるのは、登録済みのデベロッパのみです。

アプリの登録時点で、デベロッパは API 製品を 1 つ以上選択します。例えば、さまざまなタイプのサービスと価格プランに合わせて複数の API 製品を公開する場合、アプリデベロッパは、利用可能な API 製品のリストから選択できます。

Edge では、デベロッパが複数の API 製品をアプリに関連付ける必要はありません。デベロッパが API 製品を 1 つしか選択できないように公開プランを構成したり、デベロッパが API 製品を選択できないように、デフォルトの API 製品をすべてのアプリに自動的に割り当てることもできます。

アプリを Edge に登録すると、Edge は一意の API キーをアプリに割り当てます。アプリは、 API リソースへのすべてのリクエストの一部として、この API キーを渡す必要があります。キーが有効な場合は認証され、リクエストが許可されます。サービスプロバイダは、キーをいつでも取り消すことができますが、アプリで API にアクセスできなくなります。

API プロバイダとして、アプリの登録方法を決定します。次の操作が可能です。

  • デベロッパが組織とコンタクトを取って組織のアプリを登録する必要がある手動プロセスを使用する。この場合は、できればメールでデベロッパに API キーを送信します
  • Edge 管理 API を使用して、アプリの登録機能とキー配信を Web サイトに統合する。
  • 有料の Edge アカウントの場合は、アプリの統合と API キー配信のためのビルトインサポートを提供する Apigee Developer Services ポータルを使用する。

ベストプラクティスは、デベロッパが Edge に登録するアプリと、デベロッパが構築する実際のクライアントアプリの間に 1 対 1 の相関関係があることですが、Edge では、この相関関係は必須ではありません。例えば、デベロッパが単一のアプリを Edge に登録して、そのアプリを API 製品に関連付け、API キーを受け取る場合、デベロッパは、任意のクライアントアプリから API キーを自由に使用できます。

For more information, see Register apps and manage API keys.

タスク 4: API のドキュメント化

API 製品を公開する場合は、ドキュメントとデベロッパのフィードバックメカニズムについて考慮することが重要になります。ソーシャル公開機能を備えたデベロッパポータルは、開発コミュニティとのコミュニケーションにますます使用されるようになっています。これには、API ドキュメントや利用条件などの静的コンテンツ、ブログやフォーラムなどのコミュニティ投稿型の動的コンテンツ、カスタマサポート機能などがあります。

独自の Web サイトを構築して、ドキュメントを展開したり、有料の Edge アカウントがある場合は、Apigee Developer Services ポータルを使用できます。ポータルでは、ドキュメント、ブログ、フォーラムなど、デベロッパコミュニティのサポートに必要なビルトインサポートも用意されています。

Apigee Console を使用して、 API をドキュメント化し、コンソールをポータルに組み込むことができます。コンソールは、コードを記述する必要なく、デベロッパが API に要求できる対話型 GUI です。Console を使用すると、リクエスト、ヘッダー、本文の各パラメータの設定、リクエストとレスポンスのコンテンツの表示、API への認証資格情報の受け渡しが可能になります。

詳細については、「API コンソールとは?」を参照してください。

SmartDocs を使用すると、Developer Services ポータルで API をドキュメント化し、完全な対話型の API ドキュメントにすることができます。SmartDocs による対話型のドキュメントにより、ポータルユーザーは次の操作が可能になります。

  • API に関する情報の確認
  • API へのライブリクエストの送信
  • API からのライブレスポンスの表示

例えば、次の図は、SmartDocs を使用して、ポータルでドキュメント化された API を示しています。 この API では、特定の場所の天候情報が提供されます。

デベロッパは、"'w" クエリーパラメータの値を入力して場所を指定し、「Send the request」ボタンをクリックして、ライブリクエストとライブレスポンスを表示します。対話型ドキュメントを API に作成することで、API の確認、テストおよび評価をポータルユーザーが簡単に実行できます。

Edge 管理 API は、任意の HTTP クライアントを使用して API サービスへのアクセスを可能にする REST API です。Apigee では、SmartDocs を使用して、Edge 管理 API の対話型ドキュメントを作成します。この API ドキュメントについては、こちらを参照してください。

詳細については、「ドキュメント API に対する SmartDocs の使用」を参照してください。

Help or comments?