1.8. 3scale 管理の API の開発者ポータルのカスタマイズに関するオプションステップ

開発者ポータルで複数の API を提供する。

3scale にインポートする各 OpenAPI ドキュメントは、個別の API オファリング (個別のサービス) の基盤を提供します。開発者ポータルが複数のサービスを提供するように設定するためのメインタスクは、API 利用者がサブスクライブするサービスを選択できるようにするページを作成することです。

詳細は、マルチサービスへのサインアップ を参照してください。

開発者ポータルのページまたはページの一部を、指定する API 利用者にのみ表示するようにマークする。

開発者ポータルの一部を、特定の API 利用者グループからしかアクセスできないように設定する必要がある場合があります。ページ、ページの一部、またはメニュー項目 (これらは通常セクションに対応します) へのアクセスを制限できます。

セクションへのアクセスを制限する簡単な方法は、各セクションを API 利用者の論理グループにマッピングすることです。たとえば、パートナーである API 利用者がいるとします。partner という名前のグループを作成し、そのグループにのみ特定のセクションへのアクセス権を付与できます。

状態の変更に応じて、API 利用者に制限のあるコンテンツへのアクセスを提供できます。たとえば、API 利用者が新しいアプリケーションプランにアップグレードすると、追加のページがその API 利用者に自動的に表示されるようにできます。

アクセスを制限する別の方法は、特定のコンテンツを表示するために API 利用者にログインを要求することです。

詳細は コンテンツの制限 を参照してください。

Webhook を実装する。

Webhook を使用すると、3scale をバックオフィスのワークフローと密接に連携させることができます。3scale システムで指定のイベントが発生すると、Webhook メッセージによりバックオフィスのアプリケーションに通知が届きます。その後、アプリケーションはそのデータ (新規アカウントに関する情報など) を使用して、開発者ポータルに反映することができます。

詳細は Webhooks を参照してください。