概要

今日のデジタル時代にあって最も成功した企業は、そのビジネスに対して明白で安定したインターフェイスを作成および維持しています。企業は、社内外で、広範なインターフェイスを中心にその戦略を実行します。これらのインターフェイスは、アプリケーションプログラミングインターフェイス(API)として知られています。

API 中心のアプローチは、システム間の様々なインターフェイスの進化と管理を促進します。このアプローチでは、すべてのシステムは疎結合され、関連サービスを幅広く使用できます。API 中心のアプローチは、サービス指向アーキテクチャ(SOA)の 1 対 1 のアーキテクチャの代わりに API が 1 対多のアーキテクチャを扱うことを除けば、SOA に似ています。

結果として、REST Web サービスなど、より新しい技術は、企業 API 戦略の実践をより容易にします。

API 戦略が重要な理由

良く計画された API 戦略は、次のような複雑なソフトウェア主導の戦略を実行するうえで役立ちます。

  • 社内ソフトウェアシステムを改善するための再構築
  • メンテナンスコストの削減
  • 俊敏性とリーン生産プロセスの向上
  • 顧客エンゲージメントと保持の向上

ColdFusion API Manager とは

ColdFusion API Manager は、アプリケーションおよびその他のバックエンドシステムのコア機能を公開する API の作成を支援します。これらの API は、実行時にパブリッシュおよび管理されます。

API Manager には、次の機能が含まれます。

  • アクセス制御:API Manager は、特定の API を信頼できる利用者のみに提供し、ユーザーによる使用がロールに基づいて行われるようにします。
  • 分析:アプリケーション、メソッドおよびユーザーの API の使用状況を追跡できます。
  • ポータル:API パブリッシャーおよび利用者向けのカスタムワークフローを使用するポータルがそれぞれ別にあります。

API Manager のアーキテクチャ

API Manager のアーキテクチャ

API Manager のユーザーロール

API Manager には、次のロールが含まれます。

API 管理者 - API 管理者は、API Manager のすべてのコア機能およびプロパティを管理します。

API パブリッシャー - API パブリッシャーは、API を作成し、各 API のリソースをリストし、すべてのサブスクライブユーザーを表示し、API の指標を分析します。

API サブスクライバー - API サブスクライバーは、サブスクライブした API を参照し、API 層を選択し、アプリケーションを作成し、パブリッシャーからの通知を表示します。

API Manager の機能

API Manager には、次の機能があります。

機能 説明
API の作成

API を作成するには、次の例のように、複数の方法があります。

  • 手動で API を作成する。
  • Swagger からインポートする。
  • ColdFusion ベースの REST サービスについて、ColdFusion から内部 Swagger をインポートする。
  • SOAP サービスを REST サービスに変換する。
  • プロキシサービスを使用して SOAP API をインポートする。
API バージョン管理

API バージョン管理は、REST API の設計および構築に不可欠です。API のアップデートを行う場合、API の現在の使用法に影響を与えることなくインターフェイスの変更を行えるようにしたいものです。

API Manager では、同じ API の複数のバージョンを作成して、別々に管理できます。後で、公開されたバージョンを非推奨にして使用中止にすることができます。

API セキュリティ 次のセキュリティメカニズムを使用して API を認証できます。
  • 基本
  • API キー
  • OAuth2(SAML を使用)
ドキュメント パブリッシャーは、API の完全な説明を提供でき、サブスクライバーが API をテストするための体験ツールを提供できます。
ポータル

API Manager には、API を設定、公開およびサブスクライブしたり、レポートを表示するためのポータルがあります。次のような異なるタイプのポータルがあります。

  • 管理者ポータル:サーバー設定、SLA、通知用メール設定などを設定できます。
  • パブリッシャーポータル:API を作成、公開、表示および管理できます。
  • サブスクライバーポータル:API をサブスクライブ、表示およびテストできます。
分析ダッシュボード

ダッシュボードを使用して、API Manager の指標および API 使用統計を表示できます。次の 3 つの異なるタイプのダッシュボードがあります。

  • 管理者ダッシュボード:パブリッシャーの数、公開した API の数、API の平均応答時間などを表示できます。
  • パブリッシャーダッシュボード:複数のバージョンの API および消費パターンを表示できます。
  • サブスクライバーダッシュボード:API 使用量、API エラーなどを表示できます。
計測とスロットル API Manager には、すべてのクラスターノードにわたって機能する拡張可能な計測ソリューションが含まれています。API Manager は、指標データに基づいて非同期のスロットル呼び出しを行います。API Manager は、リアルタイムの制御のために、分散型のメモリ内データベースを使用して計測を管理します。
SLA と層 API Manager は、スループットを定義し、承認を強制することで、API の SLA 層の作成を支援します。
監視と分析 API Manager は、パブリッシャー情報、サブスクライバー情報、API リソース、リクエストと応答のペイロード、エンドポイントからの応答ステータス、応答時間、応答形式、SLA プランなど、すべての情報を監視サーバーに公開します。このデータは、ネットワーク内外の分析サーバー上に公開されます。管理者、またはパブリッシャー、または利用者は、レポートを生成してデータを分析できます。
キャッシュ API Manager には、API 応答を適切にキャッシュできるキャッシングシステムが含まれています。すべてのリソースが API レベルでキャッシュできない場合、このキャッシングは、サブリソースレベルで有効にできます。
SOAP から REST への変換 ColdFusion コミュニティは、SOAP サービスを広く開発および使用しています。API Manager は、SOAP サービスをラップして、対外的に REST サービスとして公開するのを支援します。パブリッシャーが SOAP 入力パラメーターを REST パラメーターのものにマッピングするのを支援するウィザードがあります。 
SOAP プロキシ プロキシサービスを使用して SOAP API をインポートし、SOAP エンドポイントをプロキシエンドポイントにマッピングします。
クラスタリング API Manager は、分散データストアサービスをホストするマシンの IP を使用したクラスターのセットアップを支援します。
コネクタ API Manager では、コネクタが、共有ファイルを通じてすべてのノードを取得します。コネクタは ColdFusion サーバーおよび API Manager によるもので、異なるマシン上で同時に実行されます。
サンドボックス API Manager で、サンドボックス URL を設定することで、本番移行前に API をテストできます。実行時に、API キーに基づいて、API Manager がサンドボックス URL のエンドポイントを呼び出し、本番サーバーに対してリクエストを行います。また、プライマリエンドポイントサーバーがリクエストに対応できない場合に、バックアップサーバーとして動作する、フェイルオーバーサーバーもあります。
通知

API Manager で、特定のイベントをユーザーに通知できます。次に例を示します。

  • サブスクライバーがサブスクライブした SLA の終了に近づくと、そのサブスクライバーに通知します。
  • 誰かが API へのサブスクライブをリクエストすると、サブスクリプションを承認するためにパブリッシャーに通知します。
  • パブリッシャーが公開した API のステータスを「非推奨」にダウングレードすると、すべてのサブスクライバーに通知します。

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー