公開とは、アプリ デベロッパーが API を使用できるようにするプロセスです。
動画: 次の動画では、API 公開の概要について説明します。
API の公開には、このトピックで説明する次のタスクが含まれます。
- API をバンドルする Edge に API プロダクトを作成します。
- アプリケーション デベロッパーを Edge に登録します。
- デベロッパーのアプリケーションを Edge に登録します。
- 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 ドキュメントや利用条件などの静的コンテンツ、ブログやフォーラムなどのコミュニティ投稿型の動的コンテンツ、カスタマー サポート機能などがあります。
独自の Web サイトを構築して、ドキュメントをデプロイできます。また、有料の 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 の使用をご覧ください。