English
お問い合わせ

SAP Business Technology Platform － SAP Integration SuiteでSlackにメッセージを投稿してみました（2） －

2023年1月31日

本記事は「SAP Business Technology Platform － SAP Integration SuiteでSlackにメッセージを投稿してみました(1) －」の後編です。前回はSAP Integration SuiteのOpen Connectorを利用して、Slackにメッセージを投稿する方法を紹介しました。
今回は、SAP Integration Suiteの機能の1つであるAPI Managementを利用します。
APIプロキシとAPI Business Hub Enterpriseの作成を行い、API Business Hub EnterpriseからAPIを実行してSlackにチャネルの作成とメッセージの投稿を行います。

INDEX

検証の流れ

検証については、下記の流れで実施していきます。

  • APIプロバイダの作成：APIプロキシを作成するための前提となる作業です。前回の検証で利用したOpen Connectorの接続情報を登録します。

  • APIプロキシの作成：APIの接続ポイントとなるAPIプロキシを作成します。
  • APIプロキシのテスト：APIプロキシが正常に設定されたか確認します。
  • API Productの作成：API Business Hub Enterpriseを設定するための前提作業です。APIプロキシの情報やAPIプロキシで設定したAPIの実行制限をセットとして登録します。
  • API Business Hub Enterpriseの作成：APIを実行できるユーザの登録およびAPI Productで設定したAPIのセットを登録します。
  • Slackにチャネルの作成：API Business Hub Enterpriseを利用して、Slackにチャネルを作成します。
  • Slackにメッセージを投稿する：API Business Hub Enterpriseを利用して、Slackにメッセージを投稿します。

API Managementの機能について

利用するAPI Managementの機能の説明については、下記の通りです。

  • API プロキシ：APIを実行するサービスとAPIを要求する元（クライアント）の接続先となります。クライアントはAPI プロキシを経由して接続するので、APIを実行するサービス側で変更が生じても、クライアント側での設定変更は不要になります。

  • API プロバイダ：APIの接続先を設定します。APIプロキシを設定する際に必要な情報です。
  • API Product：APIの接続先やAPIの実行数の制限を定義したセットです。
  • API Business Hub Enterprise：設定、作成したAPIを一か所で管理できるポータルページです。

API Managementで実施する内容について、下記の図の①、②、④、⑤が検証の流れの1、2、4、5で設定する箇所となります。

GSL_Tech_Blog_15-1.png

1.　API プロバイダの作成

（ア）Open Connectorの画面下にある歯車マークをクリックし、Organization SecretとUser Secretを手元に控えます。

GSL_Tech_Blog_15-2.png

（イ）SAP Integration Suiteのホーム画面の左側の項目一覧からConfigure APIsを選択し、「Create」ボタンをクリックします。

GSL_Tech_Blog_15-3.png

（ウ）Add API Providerの画面が表示されます。Overviewタブでは、Nameに今回作成するAPIプロバイダの名前を入力します。

GSL_Tech_Blog_15-4.png

（エ）Connectionタブでは接続先情報を入力します。今回は前回の検証で作成したOpen Connectorの情報を入力します。

  • Type：Open Connectors

  • Region：Open Connectorを作成したアカウントの地域
  • Host:自動入力
  • Port：自動入力
  • Organization Secret：（ア）で控えたOrganization Secret
  • User Secret：（ア）で控えたUser Secret

GSL_Tech_Blog_15-5.png

2.　API プロキシの作成

（ア）左側の項目一覧からDesign APIsを選択し、「Create」ボタンをクリックします。

GSL_Tech_Blog_15-6.png

（イ）Create APIダイアログボックス内で下記を設定します。

  • Select：「API Provider」を選択

  • API Provider：1.　API プロバイダの作成で作成したAPIプロバイダ名

（ウ）「Discover」ボタンをクリックします。

GSL_Tech_Blog_15-7.png

（エ）Open Connectorインスタンスを選択し、「OK」をクリックする。

GSL_Tech_Blog_15-8.png

（オ）「Create」ボタンをクリックします。

GSL_Tech_Blog_15-9.png

（カ）「Save」ボタンをクリックします。

GSL_Tech_Blog_15-10.png

（キ）左側の項目一覧からDesign APIsを選択します。Develop画面に作成したAPIプロキシ名が表示されます。Actionタブから「Deploy」を選択する。

GSL_Tech_Blog_15-11.png

（ク）StatusがDeployedになったことを確認します。これでAPIプロキシの作成が行われました。

GSL_Tech_Blog_15-12.png

3.　API プロキシのテスト

（ア）左側の項目一覧からTest APIsを選択し、API Test Consoleから作成したAPIプロキシを選択します。API Actionの一覧から「GET」を選択します。

GSL_Tech_Blog_15-13.png

（イ）リストボックスから末尾が/Slack/channelsのURLを選択し、「Send」ボタンをクリックします。

GSL_Tech_Blog_15-14.png

（ウ）画面下部にリクエストの成功コードである「200」が表示されることを確認します。

GSL_Tech_Blog_15-15.png

4.　API Productの作成

（ア）左側の項目からDesign APIを選択し、Productタブの「Create」ボタンをクリックします。

GSL_Tech_Blog_15-16.png

（イ）Overviewタブに以下の情報を記載する。

  • Name：API Productの名前

  • Title：API Productのタイトル
  • Quota：Requests Everyで指定した期間に実行できるAPIの実行数
  • Requests Every：Quotaを定義する期間

GSL_Tech_Blog_15-17.png

（ウ）APIs（0）タブの「Add」ボタンをクリックします。

（エ）Add APIsのポップアップから作成したAPIプロキシ名を指定し、「OK」をクリックします。

GSL_Tech_Blog_15-18.png

（オ）一度、画面にログインする必要があるため、API Business Hub Enterpriseをクリックし、API Business Hub Enterpriseのページにログインします。

GSL_Tech_Blog_15-19.png

（カ）Design APIタブのProductタブで、作成したProductを選択し、「Publish」をクリックします。

GSL_Tech_Blog_15-20.png

（キ）Statusが変更されました。

GSL_Tech_Blog_15-21.png

5.　API Business Hub Enterpriseの作成

（ア）API Business Hub Enterpriseをクリックし、Manage Usersタブ配下のRegistered Users タブ、「Add User」をクリックします。

GSL_Tech_Blog_15-22.png

（イ）ポップアップで下記の情報を入力し、「Add」をクリックします。

  • User ID：登録するユーザのIDもしくはメールアドレス

  • First Name：登録ユーザの名
  • Last Name：登録ユーザの姓
  • Email ID：登録するユーザのメールアドレス
  • Assigned Roles：ユーザに付与する権限
  • Country Region：ユーザが所在する国/地域

GSL_Tech_Blog_15-23.png

（ウ）My WorkSpaceタブ配下のApplicationタブ、「Create New Application」を選択します。

GSL_Tech_Blog_15-24.png

（エ）下記の情報を入力します。

  • Title：API Business Hub Enterpriseで表示されるアプリケーション名

GSL_Tech_Blog_15-25.png

（オ）Add ProductsタブのAvailable Productsで今回設定するAPI Productsを選択します。

GSL_Tech_Blog_15-26.png

（カ）Application Infoタブに戻り、「Create」をクリックします。

（キ）My Workspaceタブの（エ）で作成したApplication名のタイルをクリックし、Applicationの情報が表示されることを確認します。

GSL_Tech_Blog_15-27.png

6.　Slackにチャネルの作成

（ア）Productsを選択し、APIsタブの配下、API プロキシ名のタイルをクリックします。

GSL_Tech_Blog_15-28.png

（イ）ChannelsタブのPOST/channelsを選択し、下記の情報を入力します。

  • Authorization：「1.　API プロバイダの作成」（ア）で控えたキー

  • name：作成するチャネル名を記載します

（ウ）「Execute」ボタンをクリックし、リターンコード200が返ってくることを確認します。

GSL_Tech_Blog_15-29.png

GSL_Tech_Blog_15-30.png

（エ）（イ）で指定した名前のChannelが作成されたことを確認します。

GSL_Tech_Blog_15-31.png

7.　Slackにメッセージを投稿する

（オ）ChannelsタブのPOST/channels/{channelId}/messagesを選択し、下記の情報を入力します。

  • Authorization：「1.　API プロバイダの作成」（ア）で控えたキー

  • name：「6.　Slackにチャネルの作成」（ウ）で控えたID
  • body：text部分に投稿するメッセージを記載します

GSL_Tech_Blog_15-32.png

（カ）「Execute」ボタンをクリックし、リターンコード200が返ってくることを確認します。

（キ）Slackのチャネルにメッセージが投稿されたことを確認します。

GSL_Tech_Blog_15-33.png

おわりに

今回の検証では、前回作成したOpen Connectorインスタンスに対してAPIプロキシを設定し、API　Business Hub Enterpriseの管理画面よりSlackのChannel作成とメッセージの投稿を実施しました。

他のAPIを利用する際もAPI Business Hub Enterprise Pageを作成することによって、一元的にAPIを実行管理することができますので、管理の利便性が上がります。

今後も本ブログでは、引き続き皆様にお役立ちする情報を提供していきます。

参考

Open Connectors、API Managementを利用したチュートリアル（前回と今回のBlogで実施）