Language and Page Formatting Options

用語

Red Hat 3scale API Management 2.6

Red Hat 3scale API Management Platform で使用される用語をすべて説明します。

概要

本ガイドでは、Red Hat 3scale API Management 2.6 で使用される用語を説明します。

第1章 3scale の用語

本セクションは、3scale プラットフォームで使用される共通用語に関する用語集です。

1.1. アクセストークン

アクセストークンは、Account Management API、Analytics API、および Billing API を呼び出すときに認証に使用されるキーです。

1.2. ActiveDocs

ActiveDocs は、REST API を文書化するための 3scale 仕様です。ActiveDocs は、人気のある Swagger フレームワークに基づいています。ActiveDocs を使用すると、API はインタラクティブなドキュメントを取得します。これにより、開発者は Web サービスを理解しやすくなり、インストールなしでテストすることも容易になります。

1.3. 管理ポータル

管理ポータルから、API プロバイダーは API と 3scale の統合を設定し、アプリケーションプランを管理し、内部メンバーと外部顧客にアクセスを許可し、アプリケーションキーごとのトラフィックを制限し、開発者ポータルをカスタマイズできます。これは API プロバイダーの中央コンソールです。API へのアクセスを管理および保護します。管理ポータルには、開始点として Dashboard が含まれています。

1.4. API

API は、アクセス可能な 1 つ以上の メソッド の論理バンドルです。指定された API プロバイダー は、1 つ以上の API を公開する場合があります。API という用語は、Service という用語と置き換え可能な用語で使用されます。

3scale には、3scale ActiveDocs にある独自の API もあります。これは、管理ポータルの ドキュメント → 3scale API ドキュメント セクションで利用できます。

1.5. APIcast ゲートウェイ

APIcast は、内部および外部の API サービスを 3scale API Management Platform と統合するのに使用される NGINX ベースの API ゲートウェイです。API ゲートウェイは、API リクエストを処理するインターフェイスです。設定に応じて、アクセス制御、レート制限、セキュリティーフィルタリング、ロギング、ルーティング、キャッシングなどを処理できます。

APIcast とその展開オプション (ホスト型、自己管理型、およびさまざまな設定オプション) の詳細については、APIcast の概要 を確認してください。

1.6. API クレデンシャル

クレデンシャルは、アプリケーションに関連付けられたキー、シークレット、または識別子のセットであり、アプリケーションが API にアクセスすることを許可します。資格情報の形式は、API で使用されている認証パターンによって異なります。

1.7. API 利用者

API プロバイダー が提供する API にアクセスする個人、グループ、または企業。組織および API を使用するために組織が作成したソフトウェアアプリケーションの両方を指す場合があります。指定した組織は、API にアクセスする 1 つまたは複数のアプリケーションを持つことができます。

1.8. API キー

API キーは、アプリケーションが特定の API で呼び出しを行うことを許可される資格情報の一種です。API キーは、特定の種類の認証パターンです。

  • アプリケーション API キー: 3scale で (ユーザーまたは API を介して) 新しいアプリケーションが作成されたときに生成されます。API へのアクセスを提供します。アクセスの種類は、アプリケーションプラン によって決まります。
  • プロバイダー API キー: 3scale で新しいプロバイダーアカウントが作成されたときに生成されます。プロバイダーアカウントに関連付けられた 3scale API へのフルアクセスを付与します。
注記

サービストークンを使用して Service Management API に対して認証し、アクセストークンを使用して Account Management API、Analytics API、Billing API に対して認証することを強くお勧めします。カスタム/制限されたアクセススコープにより、このプロバイダー API キーを使用するよりも本質的に安全になります。

1.9. API プロバイダー

ドキュメントとガイドでは、API プロバイダー (3scale のお客様) は、1 つ以上の API を所有し、3scale API 管理プラットフォームを使用してそれらを管理する個人、グループ、または企業です。API プロバイダーは、組織内の他のチーム、または外部のサードパーティー開発者、パートナー、もしくは一般ユーザーがその API にアクセスできるようにすることが可能です。 

1.10. アプリケーション

アプリケーションは、API にアクセスするために API コンシューマー によって開発されるソフトウェアコードの一部です。アプリケーションは、通常、3scale システム内で、API の固有の API クレデンシャル セット、API に送信された呼び出しのトラフィック履歴、およびアプリケーションの作成時に取得されたメタデータに関連付けられています。アプリケーション開発者アカウントにリンクされます。

1.11. 認証

認証は、アクセスを要求しているユーザーまたはサーバーの身元を確認するプロセスです。このプロセスは、アクセスできるリソースを決定する承認プロセスの前に行われます。

1.12. 認証パターン

API コンシューマー が API のメソッドにアクセスするために必要な資格情報を表現するために、特定の API で使用される技術スキーム。3scale 内の各 API は、1 つの認証パターンのみを選択できます。

1.13. Base URL

これはホスト URL です。例: https://my-api.com

  • 公開ベース URL: これは、API クライアントによって呼び出されるエンドポイントのルートです。
  • プライベートベース URL: これは API バックエンドサービスの内部ホストです。

1.14. コードプラグイン

プラグインは、別のサーバーを実行せずに API アクセス制御および API トラフィックレポートを有効にする 3scale API のラッパーを提供します。プラグインは、API を有効にするコード内に存在します。プラグインは、アクセス制御およびトラフィックレポートのために 3scale API を呼び出します。

1.15. デプロイメントのオプション

「統合オプション」と同じです。3scale では、APIcast ゲートウェイ (3scale API Management Platform ではありません) をデプロイする方法について話すとき、通常はデプロイオプションを参照します。

1.16. 開発者アカウント

開発者アカウントは、特定の API をサブスクライブするアカウントです。開発者アカウントは、アプリケーションの親です。新規開発者が API にサブスクライブすると、アプリケーション が API に対して自動的に作成され、それがサブスクライブされる API に対する呼び出しを行うことができます。

1.17. 開発者ポータル

開発者ポータルは、開発者が API をサブスクライブできるサイトです。開発者ポータルから、開発者はサブスクリプションの管理、API キーへのアクセス、アプリケーションの作成、インタラクティブな API ドキュメント (ActiveDocs) へのアクセス、API の使用状況の確認などを行うことができます。すぐに使用できる機能を備えた 3scale CMS を使用すると、新規顧客のオンボーディングに必要なものをすべて備えた開発者ポータルをすばやく作成できます。

1.18. エンドポイント (API エンドポイント)

エンドポイントは、アプリケーション によって API で実行できる特定の呼び出しまたはトランザクションです。通常、メソッドは、オブジェクトのリストの取得や新しいオブジェクトの作成など、実行できる 1 つの特定のアクションに対応します。通常、API には複数のエンドポイントがあります。この用語はメソッド用語と同等です。

1.19. エンドユーザー

エンドユーザーは、1 つまたは複数の API を呼び出す アプリケーション のユーザーです。

1.20. フィールド定義

管理ポータルのフィールド定義セクションから、内部管理者/メンバー、開発者アカウント、およびアプリケーションからデータを収集するための新しいフィールドを追加および/または作成することができます。これらは、新しいアカウントが作成されたときに表示されるフィールドです。たとえば、開発者ポータルの開発者サインアップフォームに、アドレスなどのフィールドを追加できます。これらのフィールドはオプションまたは必須フィールドにすることができます。

1.21. インテグレーションエラー

統合エラーは、呼び出しが不正な クレデンシャル または トークン のセットで実行された場合、または不正な ID、URL で呼び出しが実行された場合に 3scale によって生成されます。これらのエラーは、API を呼び出しているアプリケーションから発生したエラーである可能性や、API と 3scale の統合。

1.22. 統合オプション

デプロイオプション とも呼ばれる統合オプションは、API を 3scale Management Platform (NGINX、プラグインなど) と統合するために使用できるオプションです。

1.23. マッピングルール

マッピングルールは、特定の エンドポイント からの着信呼び出しを、3scale で作成された対応するメソッドおよびメトリクスにマッピングします。

使用状況の追跡、エンドポイントアクセス、および制限は、これらのマッピングルールで設定された メソッド とメトリックメトリック に基づいています。

マッピングルール に関するドキュメントを参照してください。

1.24. メソッド (API メソッド)

メソッドを使用すると、3scale で API の使用状況を追跡できます。API の API エンドポイント で使用可能な HTTP メソッドごとにメソッドを追加できます。メソッドはヒットベースです。3scale のデフォルトでは、メソッド呼び出しが組み込みの hits メトリクスのトリガーとなります。他のタイプのイベントを追跡するには、別の単位でレポートするメトリックを追加できます。個々のメソッドの使用制限と価格設定ルールは、各 アプリケーションプラン 内から定義されます。

ドキュメント API の定義 (メソッドとメトリクス) を参照してください。

1.25. メトリクス

メトリクスを使用すると、API への特定の呼び出しを、統合ページの マッピングルール セクションで 1 つ以上の URL パターンにマッピングすることで追跡できます。メトリクスは累積的で、独立したものではありません。3scale の最上位の組み込みメトリクスは Hits です。必要に応じて、他の最上位メトリクスを追加できます。

ドキュメント API の定義 (メソッドとメトリクス) を参照してください。

1.26. 収益化

収益化または API 収益化という用語は、API アクセスや使用に基づいて顧客に課金するという事実を指します。プラン により API Monetization を行うことができます。

1.27. プラン

プランは、特定の API および エンドポイント へのアクセスを付与し、トラフィックを制限し、API の使用の数量化に使用されます。3scale には 4 種類のプランがあり、独自のプランまたは組み合わせて使用することができます。

  • アプリケーションプラン: これは、3scale で最も一般的なタイプのプランです。流量制御 および 課金ルール を指定して、API へのアクセス権限を設定できます。すべての アプリケーション をプランに関連付ける必要があります。1 つのアプリケーションに対してアプリケーションプランをカスタマイズすることができます。
  • アカウントプラン: アカウントレベルで価格と機能を設定するため、特定の API サービス に限定されません。1 つのアカウントに対してアカウントプランをカスタマイズすることができます。
  • サービスプラン: サービスレベルで価格設定と機能を設定するため、特定のアプリケーションに限定されません。
  • エンドユーザープラン:API のエンドユーザー向けの 使用制限価格設定ルール を確立します。これにより、アプリケーションプランで指定された許可されたヒット数のバランスを取ることができ、1 人のユーザーがすべてのクォータを自分で消費するのを防ぐことができます。

1.28. 潜在的なアップグレード

潜在的なアップグレードは、トラフィック制限のアラートをトリガーする開発者アカウントです。これらの開発者アカウントは、トラフィック量のニーズを満たすプランにアップグレードされる可能性があります。

1.29. 課金ルール

課金ルールは、システム内の特定のトランザクションの費用を決定する論理式セットです。API の使用に対する課金を行うために、プラン 内に課金ルールを作成し、請求およびアクセスレベルを決定します。詳細については、有料プランのプロビジョニング 方法をご覧ください。

1.30. レート制限または使用制限

レート制限は プラン に関連付けられており、特定のメソッド、エンドポイント、またはメトリックの API コンシューマーによる使用のしきい値を定義する論理式です。

これらの制限は アプリケーションプラン で設定されます。詳細については、こちら を参照してください。

1.31. サービス

3scale では、API と サービス の両方の用語が API サービスを指すために使用されます。API サービスは、アクセス可能な 1 つ以上のメソッド (または エンドポイント) の論理的なバンドルです。特定の API プロバイダー は、そのような API サービスを 1 つ以上公開する場合があります。

3scale には、3scale ActiveDocs に独自の API もあり、管理ポータルの Documentation → 3scale API Docs セクションで利用できます。

1.32. サービストークン

サービストークンは、3scale Service Management API を呼び出すときに認証に使用されるキーです。

1.33. Subscription

アカウントとサービス間の契約 (プラン)。

1.34. Swagger

ActiveDocs を参照してください。

1.35. Webhook

Webhook は、イベントの後にトリガーされるプロセスであり、Webhook は即時通知メカニズムとして機能します。

Webhook に関するドキュメントを参照してください。