1.7. 3scale 管理の API のデベロッパーポータルへのアクセスを許可するための要件

必要な外観と操作感になるように、3scale ネイティブデベロッパーポータルを変更します。

HTML、CSS、Liquid、および Web サイト全般に精通している開発者は、ネイティブ Echo API デベロッパーポータルを変更してデベロッパーポータルの Web ページを作成することができます。この開発者は、ページを作成して、システムが生成したページのコードを変更して、API 利用者がデベロッパーポータルで表示するものを自由に作成することができます。

3scale API プロダクト、バックエンド、アプリケーションプランを定義し、ポリシーをプロダクトに割り当てます。

3scale プロダクトは、API を利用者に公開する 3scale リソースです。デベロッパーポータルでは、API 利用者はプロダクトのドキュメントを読み、プロダクトが提供する API の使用にサブスクライブします。3scale プロダクトには、以下の特徴があります。

管理ポータルガイド を参照してください。

3scale 管理の API を定義し、文書化する OpenAPI ドキュメントをインポートします。

デベロッパーポータルの基盤は、API を定義する OpenAPI ドキュメントです。OpenAPI ドキュメントを 3scale にインポートすると、3scale は ActiveDocs を作成または更新するため、API に関する有効なドキュメントをすぐに用意することができます。デベロッパーポータルで、API 利用者はこのドキュメントを使用して API を調べ、テストし、統合します。

OpenAPI ドキュメントに定義されている各オペレーションについて、ドキュメントをインポートすると、3scale はメソッドとマッピングルールを作成します。メソッドおよびマッピングルールは、API 利用者の API へのアクセスに対する制限およびルールを適用するのに役立ちます。

3scale ドキュメント デベロッパーポータルでの API の提供 には、3scale および OpenAPI ドキュメントを操作するための情報および手順が記載されています。特に、3scale OpenAPI 仕様として使用する OpenAPI ドキュメントの作成方法 および ActiveDocs の 3scale への追加 を参照してください。

API 利用者が 3scale 管理の API にアクセスするためにサインアップする方法のワークフローを設定します。

サインアップのワークフローは、デベロッパーポータルでの API 利用者体験の最も重要な部分です。ワークフローは、セルフサービスから、誰が何にアクセスできるかを完全に制御するものまで、多岐にわたります。アカウント、サービス、およびアプリケーションプランにより、複数のレベルの粒度を提供します。それぞれのレベルで、管理する承認ゲートがあるかどうかと、API 利用者が何らかの選択を要求されるかどうかを制御できます。

最大限の自動化とセルフサービスに対応するために、すべての承認ステップを削除し可能なデフォルトプランをすべて有効にすることができます。サインアップ後すぐに、API 利用者のデベロッパーポータルへのアクセスを提供するキーを発行できます。

ネイティブデベロッパーポータルは、ユーザー、アカウント、アプリケーションのサインアップに関して一般的に使用されるフィールドを提供します。一般的に使用されるこれらのフィールドに、カスタムフィールドを追加する必要がある場合があります。詳細は、サインアップフローの設定 および カスタムのサインアップフォームフィールド を参照してください。メールテンプレートをカスタマイズする前に、必ずワークフローを設定してください。

API 利用者の認証を実装します。

API 利用者のデベロッパーポータルへのアクセスを認証することにより、デベロッパーポータルのリソースおよび API が保護されます。以下の方法のいずれかを使用して、デベロッパーポータルへのアクセスを認証することができます。

デベロッパーポータルの認証 を参照してください。

デベロッパーポータルと API 利用者間のメール通信用に、3scale ネイティブテンプレートをカスタマイズします。

サインアップ時のアカウントアクティベーションリンクの提供、パスワードの復元、サービス料金、変更通知など、多くのさまざまなイベントで、デベロッパーポータルと API 利用者間の通信が必要です。3scale では、デベロッパーポータルが API 利用者に送信する標準的な電子メールタイプごとにテンプレートが提供されています。

サインアップワークフローを定義したら、電子メールメッセージの内容をカスタマイズします。これにより、デベロッパーポータルで設定したワークフローに密接に一致させることができます。

メールテンプレート および Liquids:メールテンプレート を参照してください。

API 利用者が 3scale 管理の API にアクセスするために合意しなければならない規定、条件、およびポリシーを指定します。

API 利用者がサインアップして API を呼び出すのを許可する場合、通常はアクセス権限を付与する前に規定、条件、およびポリシーに同意してもらいます。登録するため、特定のアプリケーションを使用するため、または特定のサービスを使用するため (デベロッパーポータルが複数のサービスを提供する場合) など、さまざまなバージョンの契約条件を設定することができます。

API の使用を有料にする場合は、おそらくクレジットカードポリシーへの同意も必要になります。

契約条件の設定 を参照してください。

API 利用者の請求およびクレジットカードゲートウェイを設定します。

3scale の請求プロセスは毎日実施されます。有料サービスにサブスクライブしている API 利用者アカウントごとに請求書を作成します。請求書のステータスは、open、finalized、pending、unpaid、paid、failed、cancelled のいずれかです。3scale では、請求書の処理用に設定する支払いゲートウェイを使用します。

3scale の請求プロセスは、前払いモードまたは後払いモードで実施することができます。3scale における請求は暦月に基づき、月の初日に特別なイベントが発生します。

管理ポータルガイドの請求 を参照してください。