API7 Enterprise v3.3.0 支持 API Portal

開発者ポータルの概要

開発者ポータルは、APIの利用者（例：サードパーティの開発者や内部チーム）向けに設計された専用プラットフォームで、APIドキュメント、テストツール、関連リソースへの統一されたアクセスを提供します。このポータルは、開発者がAPIを迅速に理解し統合することを支援するだけでなく、管理とセキュリティのレベルでの可視化と制御機能を強化します。APIゲートウェイプラットフォームにとって、開発者ポータルを提供することで以下のことが可能になります：

1. API公開の効率化: 分散したドキュメント、例、インターフェース仕様を統一されたプラットフォームに統合することで、統合コストを大幅に削減し、外部システムとの製品統合を加速します。

2. 開発と運用の効率向上: ドキュメント検索、テスト、デバッグなどのセルフサービス機能により、繰り返しのコミュニケーションやドキュメントのメンテナンスが減少し、全体の効率が向上します。

3. 集中管理と監視: プラットフォームは、APIの使用状況の追跡、レスポンス分析、主要なメトリクスの監視、および潜在的な問題の早期発見をより効果的に行うことができます。

API7 Enterprise 3.3.0では、API7 Gatewayがユーザー提供のAPIドキュメントから直接開発者ポータルを自動生成する機能をサポートしています。これにより、組織はAPIリソースを外部に公開する際により簡単に利用できるようになり、開発者にとって一貫した便利な体験を提供します。

API7プロバイダーポータルと開発者ポータル

API管理プラットフォームとして、API7プロバイダーポータルと開発者ポータルは補完的な役割を果たしますが、異なる対象者と機能に対応しています。

API7プロバイダーポータル

API7プロバイダーポータルは、APIプロバイダー向けの管理コンソールで、APIライフサイクル管理を容易にします。

• 対象者: APIプロバイダーと管理者
• 主な機能:
  • API製品の公開と管理。
  • 開発者の管理。
  • 開発者ポータルへのアクセスポリシーの設定（例：匿名API閲覧やログイン方法）。
  • APIアクセス統計の可視化、分析、ログの追跡。

API7開発者ポータル

API7開発者ポータルは、開発者やパートナー向けに統一されたセルフサービスエントリーポイントを提供し、APIサービスを迅速に理解、アクセス、利用できるようにします。

• 対象者: APIの利用者（例：サードパーティの開発者、パートナー、内部開発チーム）
• 主な機能:
  • APIドキュメント、使用ガイド、サンプルコードの提供。
  • オンラインテストとデバッグインターフェースの提供。
  • アプリケーション登録の管理、APIキーの取得、認証情報の処理。

API7ポータルの使用方法

API7プロバイダーポータルへのアクセス

API7 Enterpriseダッシュボードにログイン後、ユーザーはデフォルトでゲートウェイ管理ページにリダイレクトされます。API7プロバイダーポータルに切り替えるには、左上のトグルボタンをクリックします。切り替えると、ページタイトルがAPI7プロバイダーポータルに更新され、左側のメニューにAPI製品の管理に関連するオプションが表示されます。

API製品の作成と公開

API製品は、API7プロバイダーポータルのコアリソースであり、関連するAPIのグループを表します。開発者は通常、製品レベルでAPIをサブスクライブします。API製品を作成する方法は2つあります。

1. API7 Gatewayで公開されたサービスに基づく

• API7 Gatewayで公開された既存のサービスを選択し、それらをAPI製品にグループ化します。
• API製品内では、各サービスの対応するルートが独立したAPIとして扱われます。

2. OpenAPIファイルのインポート

• 既存のOpenAPIファイルをインポートしてAPI製品を迅速に生成します。
• この方法で作成された製品は、ゲートウェイの設定に直接リンクされないことに注意してください。

例: API7 GatewayからAPI製品を追加

API製品を追加するには、「Add API Product」ボタンをクリックし、「From API7 Gateway」メニュー項目を選択してAPI製品作成フォームにアクセスします。

フォームでは、以下の情報を入力する必要があります：

1. 基本情報: 名前、説明、ラベル、ロゴなど。

2. 認証タイプ: 承認が必要かどうかを指定します。

3. 可視性: API製品の可視範囲を設定します。

4. リンクされたゲートウェイサービス: 以下の2つの条件を満たす公開されたゲートウェイサービスを選択します：

   • ホスト名が設定されている。
   • OpenAPIドキュメントがアップロードされている。

新しいAPI製品の追加

条件を満たすサービスがない場合、以下の設定手順に従ってください。

1. 既存サービスのOpenAPIドキュメントをアップロードし、ホスト名を設定

サービスの詳細またはサービステンプレートページで、左側のナビゲーションバーにあるOpenAPI Specificationをクリックします。次に、サービスに対応するOpenAPIドキュメントをアップロードします。ドキュメント内のAPI定義がサービスの実際のルートと正確に一致することを確認してください。これにより、開発者がデバッグ中に正確なAPIドキュメントを参照し、アップストリームへのアクセスに成功することが保証されます。

ドキュメントをアップロード後、リアルタイムでプレビューできます。これは、開発者がアクセスする最終的なAPIドキュメントと一致します。

次に、サービスの詳細またはテンプレート詳細ページのRoutesセクションで、Request URLモジュールのhostsを設定します。デフォルトでは、hostsは**"*"**に設定されており、サービスは任意のホスト名からのリクエストを処理します。

サービスをAPI製品にリンクするためには、正確なホストを指定する必要があります。これにより、開発者が完全なパス形式（host + path prefix + API）でAPIにアクセスできるようになります。

2. API製品にリンクする新しいサービスの作成

公開されたサービスがない場合、OpenAPIドキュメントをサービステンプレートとしてアップロードし、公開するか、ゲートウェイグループで直接サービスを作成できます。この方法で作成されたサービスは、OpenAPIで定義されたAPIを自動的にルートとして解析し、ドキュメントを再アップロードする必要なく保持します。前述の通りhostを設定し、サービスをAPI製品にリンクできるようにします。

ゲートウェイ設定が完了したら、プロバイダーポータルに戻り、Add Linked Gateway Serviceをクリックします。必要な公開サービスを選択してリンクを完了します。

デフォルトでは、新しく作成されたAPI製品はドラフト状態であり、開発者には表示されません。公開前に、APIドキュメント、可視性設定、認証設定を確認してください。API製品のイベント通知（例：サブスクリプションの承認またはキャンセル）を設定することをお勧めします。これにより、重要な更新を見逃すことを防げます。

API製品の公開

API製品を確認した後、右上のPublishボタンをクリックし、確認します。可視性設定に一致する開発者は、開発者ポータルを通じて製品にアクセスできるようになります。

API7開発者ポータルへのアクセス

API7開発者ポータルには2つの方法でアクセスできます：

1. 開発者ポータルのURLにアクセスする。
2. API7ポータルダッシュボードの左メニューにあるDeveloper Portalボタンをクリックする。

API7開発者ポータルのホームページで、右上のLoginボタンをクリックしてログインします。

開発者の作成

開発者アカウントを作成する方法は2つあります：

• 自己登録: 開発者がログインページで自分自身を登録します。
• 管理者招待: 管理者がAPI7ポータルダッシュボードを通じてアカウントを作成します。

自己登録

ログインページのSign upボタンをクリックし、ユーザー名とパスワードを入力してフォームを完了します。

管理者による登録

API7ポータルダッシュボードで、Developersセクションに移動し、Invite Developerをクリックします。ユーザー名と一時パスワードを入力し、必要に応じて識別用の表示名を提供します。

開発者を追加した後、ユーザー名とパスワードをユーザーと共有します。初回ログイン時には、パスワードをリセットする必要があります。

API製品の表示

ログイン後、開発者はAPI Hubをクリックして公開されたすべてのAPI製品を表示できます。

APIドキュメントの表示に加えて、システムは詳細ページで各APIの多言語コードサンプルを生成することをサポートしています。開発者はこれらのサンプルコードを開発環境にコピーしてテストできます。

API製品のデバッグ

さらに、開発者はTest Requestボタンをクリックして直接APIをテストできます。

Test Requestをクリックすると、オンラインテストパネルが表示されます。

• Request URLは、API製品に関連付けられたサービス設定に基づいて自動生成されます。
• Authentication MethodはデフォルトでKey Authに設定され、現在の開発者アカウントのAPIキーが自動的に入力されます。

開発者は、APIインターフェース定義に従って必要なリクエストパラメータを補充するだけで、デバッグを進めることができます。

API製品のサブスクライブ

API製品が特定のユーザーに制限されている場合、プロバイダーポータルの管理者は製品の可視性設定でUnsubscribed developers can view API detailsオプションを無効にすることができます。これにより、開発者はAPIにアクセスまたは呼び出す前に製品をサブスクライブする必要があります。

この設定で開発者がAPI製品の詳細ページにアクセスすると、「Subscribe to Unlock」ボタンが表示されます。ボタンをクリックすると、プロバイダー管理者にサブスクリプションリクエストが送信されます。

API製品の承認プロセスが有効になっている場合、開発者は管理者の承認を待つ必要があり、詳細を表示する前にアクセスが許可されます。

API7プロバイダーポータルのOrganizationメニューで、保留中の承認がある場合、承認メニュー項目の横に赤い点が表示されます。このメニュー項目をクリックすると、承認管理ページに移動します。

承認ページは、開発者がAPIリソースにアクセスするためのリクエストを管理するために設計されています。管理者はこのページで以下のリクエスト情報を確認できます：イベントタイプ、リソース名、申請者、申請時間。インターフェースを通じて、管理者はリクエストを承認または拒否するアクションを取ることができます。

承認の決定は、開発者のAPIアクセス権限に直接影響します：

• 承認: 開発者はAPI製品の詳細ページを表示し、APIを呼び出すことができます。
• 拒否: 開発者は管理者とコミュニケーションを取り、フィードバックに基づいて必要な調整を行い、リクエストを再提出する必要があります。

結論

API7 Enterpriseは、APIゲートウェイプラットフォームと開発者ポータルを統合し、APIプロバイダーと開発者の両方にとって効率的なAPI管理ソリューションを提供します。

API7プロバイダーポータルは、APIプロバイダーがAPI製品を簡単に公開、管理、監視できるようにし、開発者リソースを効果的に調整します。一方、開発者はAPIサービスを迅速に理解、統合、効率的に利用できるため、アプリケーション開発を加速します。これら2つのポータルは連携してAPIライフサイクル管理プロセスを合理化し、デプロイから呼び出しまでの各ステップをよりシームレスで効率的にします。