IBM API Connect as a Service on AWS 試用版を使ってみる

IBM API Connect の試用版が、AWS Marketplace (USリージョン)で利用できます。
この記事では、AWS上でIBM API Connectを利用するまでの手順をご紹介します。

Announcing IBM® API Connect® as a Service on AWS
IBM API Connect as a Service on AWS: Open for Business
IBM API Connect as a Service on AWSでAPI連携をクイックスタート

はじめに

IBM API ConnectのSaaS版をAWSのサイトから試用が可能です。試用期間は30日です。
IBM API Connect as a Service on AWSの試用をする場合、IBMidを利用します。（AWSのアカウントは不要です）
IBM API Connect
https://aws.amazon.com/marketplace/pp/prodview-b3u5z3pv4wccg
（30日間の試用期間終了後、引き続き利用するためには製品購入が必要となり、試用継続できません）

AWSのMarketplaceにあるIBM API Connectの"Try for free"のリンクからアクセスすると、AWSアカウントも求められますので、試行時には、IBM.comのAPI Connect free trialにアクセスしてください。

IBM API Connect as a Service on AWSの利用

IBM API Connect 環境の払い出し

IBM API Connectの払い出しと簡単な構成の流れは、以下になります。

1. IBM API Connect as a Service on AWSへアクセス
   以下のサイトにアクセスします。IBMidでログイン or IBMidをお持ちでない場合は、新規にIBMid作成します。。
   （ブラウザの他のセッションでIBMidでログイン済みの場合、そのIBMidで自動的に利用開始までリダイレクトされることがありますので注意してください）
   API Connect free trial
   

2. 国名、会社名の入力画面、重要事項の説明画面の表示IBMidでのログイン時に、国名、会社名の入力画面、重要事項の説明画面等が表示される場合があります。それぞれ、内容を確認後、次画面に進んでください。

3. インスタンス・プロビジョニング情報画面
   インスタンス・プロビジョニング情報画面が表示されます。ここで指定する「インスタンス名」がプロバイダー組織名として作成されます。試用ユーザーごとにこのプロバイダー組織が作成され、他のユーザーのプロバイダー組織とは分離された形で稼働します。
   （プロバイダー組織名は、API呼び出し時のエンドポイントURLのパスにも含まれます）
   

利用可能なリージョンにシドニー(ap-southeast-2)が追加されました。
2023/6/1現在で、利用可能なリージョンは以下になります。

• us-east-1
• eu-central-1
• eu-west-2
• ap-southeast-2

4. API Managerによるアクセス
プロバイダー組織が作成され環境の準備が整うと、その旨のメールが、IBMidのメールアドレスに送信されます。メール文中の「Access Trial」ボタンをクリックし、API Managerにアクセスします。（このとき、「同意の要求を確認してください」という画面が表示されるかもしれませんが、そのまま「続行」をクリックします）

5. API Managerの表示
API Manager画面が表示されます。この画面でAPIの定義や公開の操作を実施します。
（右上には、試用期間の残り日数が表示されます）

API Managerの操作（API作成とテスト呼び出し）

動作確認を想定した簡易なAPI（パラメータ無し、レスポンスメッセージ無し）を定義、呼び出します。

1. ホーム画面で「APIおよび製品の開発」をクリックします。
   

2. 「開発」画面で、右上の「追加」をクリックし、API(REST、GraphQL、またはSOAP)を選択します。
   

3. 「APIタイプの選択」画面で「新規OpenAPI」を選択し、「次へ」をクリックします。
   

4. 「新規 OpenAPI の作成」画面で、タイトルを入力します。（ここでは、simpleと入力します）「次へ」をクリックします。（デフォルトで、基本パスにもその値がセットされます。基本パスは任意に変更可能です）
   

5. 「セキュア」の画面で、そのまま「次へ」をクリックします。（「クライアントIDを使用した保護」「CORS」のチェックボックスは、どちらもチェックした状態のままにします）
   

6. API定義が作成されます。右下の「APIの編集」をクリックします。
   

7. API編集画面が表示されるので、「ゲートウェイ」タブをクリックします。
   
   

8. 左端のメニューで「ポリシー」が選択されている状態で、右側のアセンブリー・フロー内にすでに配置されている「Invoke」 ポリシーをクリックし、「Invoke」ポリシー右上に表示される「削除」ポップアップ・アイコン（ゴミ箱のようなアイコン）をクリックしてInvokeポリシーを削除します。右上の「保存ボタン」をクリックします。
   
   
   

9. アセンブリ・フローの右上にある「オフライン」トグルスイッチをクリックして、オンラインに変更します。（このタイミングで、このAPI定義がSandboxカタログ上(API Gateway上)に公開され、外部からのAPI呼び出しを受け付ける状態になります）
   

10. アセンブリフロー上部にあるテストボタン(丸の中に三角のあるボタン)をクリックし、テスト・パネルを表示します。
    

11. テスト・パネル上の「操作」で「get/」を選択し、「呼び出し」をクリックします。
    
    

12. 環境が適切に構成されていれば、応答として、状況コード 200 OKが戻されます。（応答電文を定義してないので、ヘッダーだけが戻されます）
    
    

13. 以上で、簡易なAPI呼び出しによる動作確認は完了です。トグルをオフラインに戻せば、API定義がSandboxカタログ上から削除されます。

まとめ

一般的なAPI定義においては、Invokeポリシーをそのまま利用し、バックエンドAPIを呼び出します。
さらに、このアセンブリ・フロー内では、分岐やメッセージのフォーマット変換などの処理を処理ポリシーを配置してフローとして構成して実装できます。

製品の各コンポーネントや機能については製品ドキュメントを参照してください。
IBM API Connect Enterprise as a Service

なお、現在のIBM API Connect as a Service on AWSにおいては、通常製品で提供されている機能のうち、一部機能で制約がありますのでご注意ください。(GatewayScriptポリシーやXSLTポリシーなどがサポートされない、など)
詳細については、製品ドキュメントを参照してください。
Known limitations (This documentation applies to IBM® API Connect Enterprise as a Service)

引き続き、開発者ポータルの有効化と利用についてご紹介します。
IBM API Connect as a Service on AWS 試用版を使ってみる (開発者ポータルの有効化))