公開の概要

公開とは、アプリケーション デベロッパーが API を使用できるようにするプロセスです。

動画: 次の動画で、API の公開の概要を示します。

API の公開には、このトピックで説明する次のタスクが含まれます。

  1. API をバンドルする Edge に API プロダクトを作成します。
  2. アプリケーション デベロッパーを Edge に登録します。
  3. デベロッパーのアプリケーションを Edge に登録します。
  4. API のドキュメントおよびコミュニティ サポートを提供します。

動画: 次の動画で、ポータルで API を公開するために必要な手順を示します。

タスク 1: Edge での API プロダクトの作成

公開の最初のタスクでは、API プロダクトを作成します。API プロダクトとは、アプリケーション デベロッパーが使用できるように、パッケージとして提供される API リソースを集めたものです。API プロダクトは、Edge 管理 API または UI を使用して作成します。API プロダクトの詳細については、API プロダクトとは をご覧ください。

この図では、API は 2 つのプロダクトから構成されており、それぞれ 3 つの API リソースが含まれます。

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

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

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

API プロダクトの作成の詳細については、API プロダクトの作成をご覧ください。

タスク 2: Edge でのアプリケーション デベロッパーの登録

デベロッパーは、API を使用するアプリケーションを作成します。アプリケーションを登録するには、アプリケーション デベロッパーが Apigee Edge で登録します。デベロッパーは、アプリケーションを登録すると、アプリケーションが API にアクセスするための API キーを受け取ります。

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

API プロバイダとして、デベロッパーの登録方法を決定します。たとえば、デベロッパーが組織とコンタクトを取って登録する必要がある手動登録プロセスを使用できます。このデベロッパーは、メールアドレス、姓名、会社名など、必要なすべての情報を指定する必要があります。デベロッパーのリクエストを承認すると、Edge 管理 UI を使用してデベロッパーを手動で登録できます。詳しくは、アプリケーション デベロッパーの管理をご覧ください。

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

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

タスク 3: Edge でのデベロッパー アプリケーションの登録

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

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

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

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

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

詳細については、アプリを登録して API キーを管理するをご覧ください。

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

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

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

SmartDocs では、完全な対話型の API ドキュメントを Developer Services ポータルに作成できます。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 の使用をご覧ください。