用語集

ユーザーが作成した管理ドメイン

ユーザーが作成した API。「アプリケーションプログラミングインターフェイス」 も併せて参照してください。

「[Your_API_name]」 を参照してください。

ユーザーが作成したプロダクト。「プロダクト」 も併せて参照してください。

Open API Specification (OAS) をベースとする、Red Hat 3scale API Management の REST API を文書化するための 3scale 仕様。「ActiveDocs」、「OpenAPI Specification」 も併せて参照してください。

システムと共に 3scale API Manager を設定します。

「テナントアカウント」、「開発者アカウント」 を参照してください。

Open API Specification (OAS) をベースとする、ユーザーの作成した REST API を文書化するための 3scale 仕様。インタラクティブな API ドキュメントにより、開発者は API を容易に理解し、何もインストールせずに API を簡単にテストすることができます。「3scale API Management ドキュメント」、「OpenAPI Specification」 も併せて参照してください。

HTTP Basic 認証を通じてユーザーが Account Management API、Analytics API、および Billing API に対して認証できるパーソナルトークン。ユーザーは、カスタムスコープおよびパーミッションを設定して複数のアクセストークンを作成することができます。「3scale API Management ドキュメント」、「サービストークン」 も併せて参照してください。

API プロバイダーがプロダクトを管理し、プロダクトへのアクセスをセキュアにするための中心的なポータル。このポータルから、API プロバイダーはプロダクトと 3scale のインテグレーションの設定、アプリケーションプランの管理、内部のメンバーおよび外部の顧客へのアクセス権限の付与、アプリケーションキーごとのトラフィックの制限、および開発者ポータルのカスタマイズを行うことができます。「開発者ポータル」、「プロダクト」 も併せて参照してください。

「管理ポータル (Admin Portal)」 を参照してください。

「アプリケーションプログラミングインターフェイス」 を参照してください。

「3scale API Management バックエンド」 を参照してください。

ホストにデプロイされた API の実装。「アプリケーションプログラミングインターフェイス」、「バックエンド」 も併せて参照してください。

API プロバイダーが管理する API またはプロダクトにアクセスする個人、グループ、または企業。組織および API を使用するために組織が作成したソフトウェアアプリケーションの両方を指す場合があります。特定の組織には、API にアクセスするアプリケーションが 1 つ以上ある場合があります。「API プロバイダー」 も併せて参照してください。

「API キー」、「ユーザーキー」 を参照してください。

「アプリケーションプログラミングインターフェイス」、「メソッド」 を参照してください。

API およびプロダクトの所有者で、Red Hat 3scale API Management を使用してそれらへのアクセス権限を付与します。API プロバイダーは、組織内の他のチーム、または外部のサードパーティー開発者、パートナー、もしくは一般ユーザーがその API にアクセスできるように指定できます。これには、1 つまたは複数のテナントが含まれます。「API 利用者」、「テナントアカウント」 も併せて参照してください。

アプリケーションが特定の API またはプロダクトを呼び出すことができるようにするクレデンシャルの 1 つ。API キーは、特定の種類の認証パターンです。「アプリケーションプログラミングインターフェイス」 も併せて参照してください。

「管理ポータル (Admin Portal)」 を参照してください。

「メソッド」 を参照してください。

「プロダクト」 を参照してください。

NGINX をベースとする API ゲートウェイで、Red Hat 3scale API Management と内部および外部の API を統合するのに使用されます。APIcast は API リクエストを処理するインターフェイスで、設定によりアクセス制御、流量制御、セキュリティーフィルタリング、ロギング、ルーティング、キャッシング など の処理を行うことができます。「アプリケーションプログラミングインターフェイス」、「プロダクト」 も併せて参照してください。

「APIcast」 を参照してください。

アプリケーション識別子を使用して機能する認証方法。「アプリケーションキー」 も併せて参照してください。

アプリケーションキーを使用した認証方法。「アプリケーション識別子」 も併せて参照してください。

何らかのロジックを実行するために開発されたソフトウェアコードの一部。アプリケーションは、通常 3scale システム内で API の一意のクレデンシャルセット、API に送信される呼び出しのトラフィック履歴、およびアプリケーション作成時に取得されたメタデータを関連付けます。アプリケーションは開発者アカウントとリンクされます。「API 利用者」 を参照してください。「開発者アカウント」 も併せて参照してください。

「[Your_API_name]」、「APIcast」、「API キー」、「バックエンド」、「エンドポイント」、「エンドユーザー」、「メソッド」、「プロダクト」、「サービス」 も併せて参照してください。

API またはプロダクトへのアクセスを要求するユーザーまたはサーバーのアイデンティティーを確認するプロセス

「API 利用者」 を参照してください。

「開発者ポータル」 を参照してください。

機能またはサポート対象の設定に関して、サポートはされるが推奨はされなくなり、また廃止される可能性のあるもの。「廃止済み」 も併せて参照してください。

開発者が API をサブスクライブすることのできるサイト。このサイトから、開発者はサブスクリプションの管理、API へのアクセス、アプリケーションの作成、インタラクティブな API ドキュメントおよび 3scale API ドキュメントへのアクセス、API の使用状況 など の確認などを行うことができます。「管理ポータル (Admin Portal)」 も併せて参照してください。

「廃止済み」 を参照してください。

通信チャネルの一方の端。API が他のシステムと相互に作用する場合、この通信のタッチポイントはエンドポイントとみなされます。「アプリケーションプログラミングインターフェイス」、「ベース URL」、「マッピングルール」、「メソッド」 も併せて参照してください。

1 つまたは複数のプロダクトおよび API を呼び出すアプリケーションのユーザー。「アプリケーションプログラミングインターフェイス」、「プロダクト」 も併せて参照してください。

新しいユーザー、アプリケーション、またはアカウントのいずれかが作成されたときに表示されるフィールド。

すべてのメソッドがレポートする組み込みのメトリック。別の上位レベルのメトリクスをこちらに追加して、ヒット数を増やさないように他の使用状況を追跡できるようにします。「メトリック」 も併せて参照してください。

「ベース URL」 を参照してください。

間違ったクレデンシャルのセット、ID、URL アドレス など で呼び出しが行われた場合に 3scale が生成するエラーメッセージ。これらのメッセージは、API を呼び出しているアプリケーションからのエラーであったり、API と 3scale のインテグレーションに伴う設定エラーであったりします。

「管理ポータル (Admin Portal)」 を参照してください。

特定のエンドポイントからの呼び出しを、3scale で作成した対応するメソッドおよびメトリックに関連付けるルール。使用状況のトラッキング、エンドポイントへのアクセス、および制限は、マッピングルールで設定されたメソッドおよびメトリックに基づきます。「エンドポイント」、「メソッド」、「メトリック」 も併せて参照してください。

API またはプロダクトとの許可された相互作用 (GET、POST、DELETE など)。メソッドは、3scale 上のプロダクトおよび API の使用状況をトラッキングするのに使用されます。API 用の API エンドポイントで利用可能な HTTP メソッドごとに、メソッドを追加することができます。3scale のデフォルトでは、メソッド呼び出しが組み込みの hits メトリックのトリガーとなります。「アプリケーションプログラミングインターフェイス」、「エンドポイント」、「マッピングルール」、「メトリック」 も併せて参照してください。

API への特定の呼び出しのトラッキング。このトラッキングは、呼び出しを Integration ページの Mapping Rules セクションの 1 つまたは複数の URL パターンにマッピングすることで行われます。メトリックは累積的で、独立したものではありません。3scale の最上位の組み込みメトリックは Hits です。必要に応じて、最上位メトリックをさらに追加することができ、それらは別々に考慮されます。「hit (ヒット)」、「マッピングルール」、「メソッド」 も併せて参照してください。

「OpenAPI Specification」 を参照してください。

言語に依存しない RESTful API とのインターフェイス規格。これにより、ソースコードやドキュメントにアクセスしたりネットワークトラフィックを検査したりすることなく、人間とコンピューターの両方がサービスの機能を把握し理解することができます。「3scale API Management ドキュメント」、「ActiveDocs」 も併せて参照してください。

特定の API およびエンドポイントへのアクセス権限を付与し、トラフィックを制限し、API の使用に対して課金を行う手段。アプリケーションプランやアカウントプランなど、3scale にはさまざまな種類のプランがあり、単独で、または組み合わせて使用することができます。

トラフィックの上限に関する警告をトリガーする開発者アカウント。これらの開発者アカウントは、トラフィック量の要件を満たすプランにアップグレードされる可能性があります。

1 つまたは複数の API バックエンドのバンドル。「[Your_product_name]」、「管理ポータル (Admin Portal)」、「APIcast」、「アプリケーションプログラミングインターフェイス」、「バックエンド」、「エンドユーザー」 も併せて参照してください。

機能やサポート設定など、製品で提供されず、サポートされなくなったもの。「非推奨化」 も併せて参照してください。

「アプリケーションプログラミングインターフェイス」 を参照してください。

Service Management API に対して認証するのに使用されるキー。これらのキーは自動生成され、サービスごとに一意であり、同一アカウントのユーザー間で共有されます。3scale API ドキュメント内からサービストークンを使用します。「アクセストークン」 も併せて参照してください。

オンプレミス型 3scale のマスター管理ポータルでは、アカウントはテナントアカウントとみなされます。「API プロバイダー」、「開発者アカウント」 も併せて参照してください。

「アプリケーションキー」 を参照してください。

「[Your_admin_domain]」 を参照してください。