公開の概要

Apigee X のドキュメントを表示中です。
Apigee Edge のドキュメントを表示する。

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

動画: 次の動画では、API 公開の概要について説明します。

API の公開では、このトピックで説明する次のタスクを実行する必要があります。

  1. API をバンドルする API プロダクトの作成。
  2. アプリ開発者の登録。
  3. 開発者向けアプリの登録。
  4. API に関するドキュメントとコミュニティ サポートの提供。

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

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

左から右への順でデベロッパー、アプリ、API、バックエンド サービスを示す図。API アイコンとリソースがハイライト表示されています。デベロッパーから始まる点線は、デベロッパーが作成したアプリのアイコンを指しています。アプリと API アイコンの間の矢印は、API アイコンに対するリクエストとレスポンスのフローを示しています。リクエストの上にアプリキーがあります。API アイコンとリソースがハイライト表示されています。API アイコンの下にはリソースパスのセットが 2 つあり、これらは 2 つの API プロダクト(Location プロダクトと Media プロダクト)にグループ化されています。Location プロダクトには /countries、/cities、/languages 用のリソースがあり、Media プロダクトには /books、/magazines、/movies 用のリソースがあります。API の右側には、API が呼び出すバックエンド リソース(データベース、エンタープライズ サービスバス、アプリサーバー、汎用バックエンドなど)があります。

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

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

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

Apigee を使用すると、API のビジネス要件に合った API プロダクトを柔軟に作成できるという点が重要です。

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

タスク 2: アプリ開発者の登録

開発者は、API を使用するアプリを作成します。アプリ開発者は、Apigee に登録すると、アプリを登録できるようになります。アプリが登録されると、アプリに API へのアクセス権を付与する API キーを受け取ります。

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

左から右への順でデベロッパー、アプリ、API、バックエンド サービスを示す図。デベロッパー アイコンがハイライト表示されています。ハイライトされたデベロッパーから始まる点線は、デベロッパーが作成したアプリのアイコンを指しています。アプリと API アイコンの間の矢印は、API アイコンに対するリクエストとレスポンスのフローを示しています。リクエストの上にアプリキーがあります。API アイコンの下にはリソースパスのセットが 2 つあり、これらは 2 つの API プロダクト(Location プロダクトと Media プロダクト)にグループ化されています。Location プロダクトには /countries、/cities、/languages 用のリソースがあり、Media プロダクトには /books、/magazines、/movies 用のリソースがあります。API の右側には、API が呼び出すバックエンド リソース(データベース、エンタープライズ サービスバス、アプリサーバー、汎用バックエンドなど)があります。

API プロバイダとして、開発者を登録する方法を決定します。たとえば、デベロッパーが組織とコンタクトを取って登録する必要がある手動登録プロセスを使用できます。開発者は、メールアドレス、氏名、会社名など、必要な情報をすべて提供する必要があります。開発者の申請が承認されると、Apigee UI を使用して手動で登録できます。詳細については、アプリ開発者の登録をご覧ください。

タスク 3: 開発者向けアプリの登録

アプリが APIs にアクセスする前に、アプリを登録する必要があります。ただし、アプリを登録できるのは登録済みの開発者のみです。

左から右への順でデベロッパー、アプリ、API、バックエンド サービスを示す図。アプリ、リクエスト / レスポンス、API キーの矢印がハイライト表示されています。デベロッパーから始まる点線は、デベロッパーが作成したアプリのアイコンを指しています。アプリと API アイコンの間の矢印は、API アイコンに対するリクエストとレスポンスのフローを示しています。リクエストの上にアプリキーがあります。API アイコンとリソースがハイライト表示されています。API アイコンの下にはリソースパスのセットが 2 つあり、これらは 2 つの API プロダクト(Location プロダクトと Media プロダクト)にグループ化されています。Location プロダクトには /countries、/cities、/languages 用のリソースがあり、Media プロダクトには /books、/magazines、/movies 用のリソースがあります。API の右側には、API が呼び出すバックエンド リソース(データベース、エンタープライズ サービスバス、アプリサーバー、汎用バックエンドなど)があります。

アプリの登録時に開発者は 1 つ以上の API プロダクトを選択します。たとえば、さまざまな種類のサービスや料金プランに対応する複数の API プロダクトを公開できます。アプリ開発者は、利用可能な API プロダクトのリストから選択できます。

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

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

  • 開発者が組織とコンタクトを取って組織のアプリを登録する必要がある手動プロセスを使用する。その場合、通常はメールで API キーを送信します。
  • Apigee API を使用して、アプリの登録機能とキー配信をウェブサイトに統合します。
  • 有料の Apigee アカウントの場合、アプリ登録と API キー配信のビルトイン サポートを提供する Apigee Developer Services ポータルを使用します。

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

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

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

左から右への順でデベロッパー、アプリ、API、バックエンド サービスを示す図。デベロッパー アイコンがハイライト表示されています。デベロッパーの下にはデベロッパー ポータルを表すボックスがあります。ポータルには API ドキュメント、サンプル、チュートリアル、API リファレンスなどが含まれています。さらにポータルにはブログ、フォーラム、サポート ポータルも含まれています。ハイライトされたデベロッパーから始まる点線は、デベロッパーが作成したアプリのアイコンを指しています。アプリと API アイコンの間の矢印は、API アイコンに対するリクエストとレスポンスのフローを示しています。リクエストの上にアプリキーがあります。API アイコンの下にはリソースパスのセットが 2 つあり、これらは 2 つの API プロダクト(Location プロダクトと Media プロダクト)にグループ化されています。Location プロダクトには /countries、/cities、/languages 用のリソースがあり、Media プロダクトには /books、/magazines、/movies 用のリソースがあります。API の右側には、API が呼び出すバックエンド リソース(データベース、エンタープライズ サービスバス、アプリサーバー、汎用バックエンドなど)があります。

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

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

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

詳細については、以下のセクションをご覧ください。