API Connect用語集

IBM® API Connect および Cloud Manager の用語と定義の用語集。

API 管理者 (ロール) (API Administrator (role)): 自分がメンバーであるプロバイダー組織の API 製品のライフサイクルを管理する。
API イベント (API Event): レスポンスタイム、 HTTP レスポンスコード、リクエストのペイロード、レスポンスボディなど、 API Connect Analytics またはサードパーティのアナリティクスで使用するためにキャプチャされるイベント。 API イベントは、ゲートウェイ・サーバー経由で API イベントが呼び出されるたびにログに記録される。
API Gateway: プロバイダー API およびバックエンド・サービスの単一エントリー・ポイントつまり「玄関口」として機能するサービス。 API ゲートウェイは、同時 API 呼び出しを受け入れて処理し、トラフィック管理、許可とアクセス制御、モニター、および API バージョン管理を実行する。 #overview_apimgmt_glossary__dpgwも参照してください。
APIの管理: API Connect のグラフィカルなツールで、カタログ、スペース、API、ユーザー、およびプロバイダ組織、コンシューマ組織、コミュニティ内のロールの管理、開発者ポータルへの製品の公開、API の使用状況の分析が可能です。
API 設計担当者: ラップトップまたはデスクトップ・システム上でローカルに実行されるグラフィック・ツール。これにより、API を作成および変更し、それらを IBM Cloud またはコンテナー・ランタイムに公開することができます。
API 操作 (API operation): HTTP 動詞と URL パス（エンドポイント）で構成される REST API 呼び出し。例えば、 GET http://myserver.com/api/users 、ユーザーのリストを返す。
アプリケーション: API をコンシューム (呼び出し) するソフトウェア。 1 つ以上のアプリケーションが、API にサブスクライブするようにコンシューマー組織によって登録される。アプリケーションには、APIコールを呼び出す際に提供するクライアントIDとクライアント・シークレット認証情報が割り当てられる。
アセンブリー: 外部サービスに対してサイド呼び出しを行い、応答の変換と集約を実行してから、応答を呼び出し側アプリケーションに中継することができる。
アベイラビリティー・ゾーン: API Connect では、これらは通常、デプロイメント環境を反映する API Connect サービスの論理グループです。例えば、 internal と external という名前のアベイラビリティ・ゾーンがあり、それぞれで公開されているAPIを反映させることができる。あるいは、サービスが実行されている地理的な場所によって定義されるかもしれない。
カタログ: ゲートウェイおよび開発者ポータルのロジカル・パーティションとして動作するステージング・ターゲット。 APIコールおよび開発者ポータルの URLは、特定のカタログに固有のものです。
クライアント ID: 個々のアプリケーションを識別する情報。アプリケーションは、 IBM API Connect システムによって認識されるアプリケーション・キーを渡し、その API へのアクセス権限を付与されている場合にのみ、API を呼び出すことができます。アプリケーション・キーは、クライアントによって、HTTP 照会パラメーターを使用して渡される。
クライアント秘密鍵: アプリケーションの ID を検査するために、アプリケーション・キーとともに使用される情報。 API を構成することにより、クライアント・アプリケーションに対して、クライアント ID とともにクライアント秘密鍵を提供するように要求できる。クライアント秘密鍵は、実質的に、アプリケーションのみが知っているパスワードとして機能する。クライアント秘密鍵は、クライアントによって、HTTP 照会パラメーターを使用して渡される。
クラスター: 特定の機能を提供する 1 つ以上のサーバーの集合。
コールド・スタンバイ (Cold standby): フェイルオーバーが必要になるまでフェイルオーバー・サーバーが停止状態であるデプロイメント構成。その結果、ソリューションの通常の操作を復元する時間枠が長くなる。
コミュニティー: 複数のコンシューマー組織の集合。 API を公開するときにグループ化のための構成体として使用される。コミュニティーは、API の可視性およびアクセス可能性を制限するために使用される。 API は、選択したコミュニティーに公開できる。この場合、その組織内のアプリケーション開発者だけが、その API を表示することができる。
コミュニティー・マネージャー (ロール) (Community Manager (role)): 自分がメンバーであるプロバイダー組織のアプリケーション開発者コミュニティーを管理する。
コンシューマー組織 (Consumer organization): カタログ内で、カタログが公開するAPIを消費したいビジネス・エンティティの表現。例えば、サード・パーティーのアプリケーション開発会社は、( 開発者ポータルを介して) 自分自身をコンシューマー組織として登録します。その後、会社の各開発者をそのコンシューマー組織内のユーザーとして登録できる。
開発者 (ロール) (Developer (role)): 自分がメンバーであるプロバイダー組織の API、製品、およびポリシーを作成および構成する。 API 開発者は、1 つ以上のプロバイダー組織のメンバーになることができる。 API 開発者は、アプリケーション開発者とのビジネス相互関係よりも、API の技術的な実装に焦点を置きます。
開発カタログ (Development catalog): 開発中で、公開およびライフサイクル・アクションのための承認がバイパスされる API のテストに使用されるカタログ。非開発カタログが開発カタログに変換されると、保留中の承認は取り消されます。
開発者向けポータル: 開発者が API をディスカバーし、API を使用するアプリケーションを登録し、使用プランをサブスクライブし、API をテストして使用するための、カスタマイズ可能なグラフィカル Web ポータルを提供する API Connect のコンポーネント。
開発者ツールキット: API Designerと、APIとアプリの作成、編集、管理、公開を可能にする apic コマンドラインツールを含む、ローカルにインストールされたパッケージです。
ゲートウェイ: 『API ゲートウェイ (API Gateway)』を参照。
ゲートウェイ・サービス (Gateway service): マイクロゲートウェイや IBM DataPower®などの API ゲートウェイ機能を提供する API Connect サービス。
ホット・スタンバイ: サーバーのセットが、障害発生時に即座にテークオーバーする準備ができているが、そのフェイルオーバーまではトラフィックをアクティブに処理しないデプロイメント構成。
統合: API Connect ワークフローを構築し、改善するためのサードパーティツール。例えば、Slack、 Auth0 など。
統合プロファイル (Integration profile): ID、通知、API分析などの管理サービスとの統合に使用できる標準API。
鍵ストア: セキュリティ証明書（認証証明書または公開鍵証明書）と、SSL暗号化で使用される対応する秘密鍵のリポジトリ。鍵ストア・ファイルの拡張子は .jks である。
管理サーバー (Management server): すべてのクラウド構成を保管し、 API Connect内の他のサーバー間の通信を制御します。
管理サービス: 1 つ以上の管理サーバーで構成される。
メンバー (ロール) (Member (role)): 管理組織とプロバイダー組織の両方のすべてのユーザーのデフォルトのロール。すべてのユーザーには、必要なその他のロールに加えて、「メンバー」ロールが割り当てられます。
マイクロサービス: REST APIを通じて他のマイクロサービスと通信する、モジュール式で独立してデプロイ可能なアプリケーションサービス。マイクロサービスは通常、推奨、在庫、配送、請求などの機能を中心に編成されている。
相互認証: ネットワーク上の両方のエンティティーが相互に認証を行うプロセス。ネットワーク環境では、クライアントはサーバーを認証し、その逆も行われる。 TLS の場合はオプション。双方向認証とも呼ばれる。
通知設定: API Connect ユーザー (API プロバイダーおよびコンシューマー) の通知を構成する方法。
通知サービス (Notification services): E メールなどの通知機能を提供する統合。
通知テンプレート: 通知サービスのメッセージ形式および表現の構成。
OAuth プロバイダー: OAuth プロバイダーは、ログイン用の OAuth 認証を提供する。 API Connectはネイティブとサードパーティ両方のOAuthプロバイダをサポートしています。一般的なサード・パーティー OAuth プロバイダーとして、Google および Facebook がある。
OpenAPI コンポーネント (OpenAPI Components): API 仕様の一部であり、スキーマ、応答、reqeustBodies、ヘッダーなどの API 仕様の側面に関する再使用可能オブジェクトのセットが含まれる。詳しくは、[OpenAPI v3 specification](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#components-object) を参照。
組織: API を所有するか、API を使用するアプリケーションを所有するエンティティー。プロバイダー組織は、APIと関連するプランを所有し、アプリケーションを所有することもできる。コンシューマー組織は、アプリケーションのみを所有する。組織には 1 人以上の所有者がいる。組織は、プロジェクト・チーム、部署、または部門であることがある。
組織管理者 (ロール) (Organization Manager (role)): 組織管理者は、管理組織のプロバイダー組織を管理する。
パス: ユーザーが REST API にアクセスする経路を定義する。パスは、1 つ以上の HTTP 操作 (GET や POST など) で構成される。
計画: 開発者に API を提供するためのパッケージ化構成体。プランは、1 つ以上の API からの操作の集合を使用可能にし、アプリケーション開発者のコミュニティーに公開される。アプリケーション開発者は、プランにアクセスするアプリケーションを登録することにより、API へのアクセス権限を取得します。プランには、ポリシー設定の集合が含まれます。最も単純な形式の場合、プランでは、プランを通じてアクセスされるすべての API 操作に適用される単一の割り当て量ポリシーが定義されます。より高度な場合は、追加のポリシーをプランに関連付けることができます。
ポリシー: 実行時の API 呼び出しの処理中に、Gateway サーバーでの処理の特定の側面を制御する構成。ポリシーは、アセンブリー・フローのビルディング・ブロックです。ポリシーは、セキュリティー、ロギング、ターゲット・サービスへの要求のルーティング、あるフォーマットから別のフォーマットへのデータの変換などの機能を構成する手段を提供します。ポリシーは、API または計画のコンテキスト内で構成できます。
製品: 特定の使用を目的としたパッケージに API をグループ化できる方法を提供します。また、プランが含まれているため、さまざまなオファーを差別化することができる。プランは製品内でのみ作成でき、その後、これらの製品はカタログ内で公開されます。
プロバイダー組織所有者 (Provider Organization Owner): API プロバイダー組織の所有と管理、アプリケーション開発者コミュニティーの管理、API の作成と製品の定義、および API 製品ライフサイクルの管理を行う。所有者は、クラウド管理者によって、プロバイダー組織の所有者として API Connect に参加するように招待されます。
プロキシー: 要求をユーザー定義のバックエンド・リソースに転送し、応答を呼び出し側アプリケーションへ中継するアプリケーション・プログラミング・インターフェース。
リージョン: 独立した電力とネットワーク接続を持ち、他の場所から隔離されたインフラをホスティングする物理的な場所（サイトまたはデータセンター）。リージョンは、半独立ポッドやアベイラビリティゾーンなど、さらなるサブアイソレーション特性を持つこともあれば、持たないこともある。
リソース (ユーザー・レジストリー、TLS プロファイル、通知) (Resources (User registries, TLS Profiles, Notifications)): リソースは、API Connectクラウドに必要な機能（ユーザー認証、SSLセキュリティ、システム生成メールの送信など）を提供する。
ロール: ユーザーに対して機能を使用可能にするための許可が定義される。ロールごとに、付与される許可のセットは異なる。
セキュリティー定義 (security definition): API セキュリティーの特定の局面に関するすべての設定が指定される (例えば、API へのアクセスの認証に使用するユーザー・レジストリーなど)。
サーバー: 単一のアプライアンス ( IBM WebSphere IBM DataPower アプライアンスなど)。
サービス: マイクロゲートウェイ、アナリティクス、 IBM DataPower、デベロッパーポータルなど、 API Connect ランタイムの 1 つ以上のサーバープロセスを通じて実装されるユーザー設定可能な要素。
SNMP: SNMP（Simple Network Management Protocol）は、ネットワーク管理のためのプロトコルである。インターネット・プロトコル (IP) ネットワーク上のサーバー、プリンター、ハブ、スイッチ、ルーターなどのネットワーク・デバイスから情報の収集と、それらのデバイスの構成に使用される。 SNMP ホストは、 API Connect Cloud Managerで構成されます。
スペース: カタログのサブディビジョン。各スペースは、それぞれ異なる API プロバイダー開発チームによって使用され、関連するチームがそのスペースに公開する API に特に関係する管理機能の独自セットがあり、チームごとに独立してそれぞれの API を管理できる。
SSL (TLS) プロファイル (SSL (TLS) Profile): SSL/TLS プロファイルは、Web サイトを介したデータの送信を保護するために使用される。ユーザーが Web サイトに送信する情報が盗まれず改ざんもされないことが SSL 証明書によって保証される。
サブスクリプション: アプリケーション開発者が API によって提供されるリソースにアクセスする手段。アプリケーション開発者は、開発者ポータルを使用して、API が公開されているプランをサブスクライブします。
TLS: Transport Layer Security - 盗聴と改ざんを防ぐために、ネットワーク経由のセキュア通信を提供する暗号プロトコル。 SSL の後継であり、TCP 上で実行される。
TLS プロファイル (TLS Profiles): Cloud Manager および API Manager は、TLS プロファイルを使用して、Web サイトを介したデータの伝送を保護します。 TLS証明書は、ウェブサイトに送信した情報が盗まれたり改ざんされたりしないことを保証する。 TLS プロファイルは、サーバー名、使用されるプロトコル (SSL または TLS)、および相互認証が必要かどうかで構成される。
ツールキット: 『デベロッパーズ・ツールキット (Developer Toolkit)』を参照。
トラストストア: SSL/TSL接続においてサーバーが提示する証明書を検証するために使用される、信頼できる認証局(CA)からの証明書を格納する。鍵ストアは、サーバーの資格情報を格納するが、トラストストアは、サード・パーティー CA からの証明書を格納する。
ベンダー拡張 (vendor extension): 特定のユース・ケースで必要な OpenAPI (Swagger) 仕様の拡張。
表示設定: 可視性を設定すると、プロバイダー組織がアベイラビリティー・ゾーンなどのサービスにアクセスできるかどうかが決まる。