ec Bridgeワークフロー作成例

ワークフロー作成例

ワークフロー作成例

■注文時に注文内容を外部サービスに連携する

注文時に注文内容を外部サービスに連携するためのワークフローを作成します。

この例では、外部サービスにslack(※)を利用します。注文内容をslackに通知するフローを作成していきます。

ビジネス向けのチャットツール

1ワークフローの登録

注文内容を外部サービスに連携するワークフローを作成します。

1.1 新規作成

システム管理>ワークフロー設定を開き、「新規作成」ボタンをクリックします。

ワークフローの新規作成
図.ワークフローの新規作成

1.2 基本設定の入力

ワークフローの名称(任意)を入力します。「有効/無効」を「有効」すると、ワークフローが動作するようになります。この設定は、ワークフロー構築後に有効にしても問題ありません。入力できたら、「保存」ボタンをクリックして保存してください。

ワークフローの基本設定
図.ワークフローの基本設定

1.3 ワークフローのステップ登録

1.2で保存すると、ワークフロー一覧画面に戻ります。作成されたワークフローの「編集」ボタンをクリックします。

ワークフロー一覧
図.ワークフロー一覧

ワークフロー設定画面の下部に「ステップ一覧」ボタンがありますので、「ステップ一覧」ボタンをクリックしてください。

ステップ一覧
図.ステップ一覧

ステップの登録画面が表示されます。

この画面で
・注文内容を取得する
・外部サービス(slack)に連携する

のステップを追加します。

ステップ設定画面
図.ステップ設定画面

1.4 ステップ登録(注文内容を取得する)

注文確定時の注文内容を取得するステップを追加します。

注文内容の取得は、aishipの公開API(※)を利用します。

公開APIは利用申込が必要なため、サポートセンターにお問い合わせください。

公開APIをご利用中のオーナー様は、予めシステム管理>API設定でご利用設定を行ってください。

ステップ設定画面の「起点」と「終点」の間の「+」をクリックします。

新規ステップの追加
図.新規ステップの追加

ステップの編集画面に注文内容を取得するための設定を行います。

ステップ編集画面
図.ステップ編集画面
表.設定内容詳細
項目名
ステップID 登録ステップのステップID。任意にご設定ください。
タイプ 「API呼び出し」を選択してください。
説明 このステップの処理内容を任意にご記入ください。
設定 注文内容取得APIを実行するための設定をjson形式で記載します。

{
  "url": "'https://api.aispr.jp/orders/' ~ step_data('begin', 'form_data.order_no')",
  "method": "'GET'",
  "headers": {
    "X-Api-Key": "'XXXXXXXXX'",
    "Content-Type": "'application/json'",
    "X-Api-Version": "'1.0'"
  }
}

 step_data('begin', 'form_data.order_no')
は注文確定時に該当注文の注文番号を表しています。

X-Api-Keyはシステム管理>API設定で発行したAPIキーを指定してください。

設定が完了したら「保存」ボタンをクリックして保存してください。

保存が完了すると、ステップ設定に追加されます。

注文情報取得ステップの追加完了
図.注文情報取得ステップの追加完了

1.5 ステップ登録(外部サービス連携(slack通知))

外部サービス連携用のステップを登録します。今回はslackへ通知するステップを追加します。slackには注文時の注文番号と総合計(税抜)を通知するようにします。

先ほど追加したステップと「終点」の間の「+」をクリックします。

ステップの追加
図.ステップの追加

ステップの編集画面にslackへ通知するための設定を行います。

slack通知用のステップ登録
図.slack通知用のステップ登録
表.設定内容詳細
項目名
ステップID 登録ステップのステップID。任意にご設定ください。
タイプ 「API呼び出し」を選択してください。
説明 このステップの処理内容を任意にご記入ください。
設定 注文内容取得APIを実行するための設定をjson形式で記載します。

{
  "url": "'https://hooks.slack.com/services/XXXXX'",
  "body": {
    "text": "'テストサイトで注文番号:'~step_data('order_get', 'order_id')~'の注文が発生しました。注文金額:'~step_data('order_get', 'total_product_price')"
  },
  "method": "'POST'",
  "headers": {
    "Content-Type": "'application/json'"
  }
}

urlはslackのwebhookを指定しています。利用する外部サービスのAPIのエンドポイントをご指定ください。

step_data('order_get', 'order_id')
はID:order_getのステップで取得したレスポンス結果からorder_id(注文番号)を取得しています。

step_data('order_get', 'total_product_price')
はID:order_getのステップで取得したレスポンス結果からtotal_product_price(総合計)を取得しています。

設定が完了したら「保存」ボタンをクリックして保存してください。

保存が完了すると、ステップ設定に追加されます。

slack通知ステップの追加完了
図.slack通知ステップの追加完了

ここまでの設定でワークフローの設定は完了です。次は注文確定時にこのワークフローを実行するためのWebhookの設定を行います。

2Webhookの登録

注文確定時にこのワークフローを実行するためのWebhookの設定を行います。

2.1 新規作成

システム管理>Webhook設定を開き、「新規作成」ボタンをクリックします。

Webhookの新規作成
図.Webhookの新規作成

2.2 Webhook設定

注文確定時に実行されるように設定します。

Webhook設定
図.Webhook設定
表.詳細設定内容
項目名
タイミング 「(フロント)注文確定の直後」を選択
URL 1で作成したワークフローのエンドポイントを設定します
メソッド 「POST」を選択します
ヘッダー情報 下記のJSON形式で設定

{
    "X-Api-Key": "XXXXXXXXXXXX"
}

ワークフローご利用時にサポートセンターからご連絡したAPIキーを設定してください。

設定できましたら保存ボタンをクリックして保存してください。

これでWebhookの設定は完了です。

3動作確認

実際にサイトから注文してslackに通知が行われるかを確認します。

  • サイトで注文します。
  • Webhook設定
  • 注文内容がslackに通知されています。
  • Webhook設定

上記ワークフロー事例は、slackへ通知する例ですが、その他のSaaSサービスや基幹システムへの連携も可能です。

また、外部連携の前にデータ変換のステップを追加することもできるので、連携先のシステム仕様に合わせてデータ連携することも可能です。

データ変換等の仕様についてご不明点があれば、サポートセンターまでお問い合わせください。