〈 HULFT Square 技術コラム【つないでみた編】 〉

Vol.20
Zuoraにつないでみた ～HULFT Squareでサブスクリプションビジネス～

はじめに

• 柔軟に変更できる契約ライセンス数と契約期間
• サービス解約に伴う手続き
• 契約に追加するオプションや、サービス利用量に応じた従量課金への対応

Zuoraとは

公式製品ページ

• サブスクリプション契約メニューの管理と請求書の自動作成(Zuora Billing)
• サブスクリプション契約に対応したSalesforceからの見積の作成(Zuora CPQ)
• 発注書や請求書を取り込んでの収益報告レポートの作成(Zuora Revenue)
• サブスクリプション契約で発生した売掛金の回収(Zuora Collect)
• オリジナルのビジネスプロセスに対応するための独自ワークフローの開発(Zuora Central Platform)

• Zuora上で設定されたサブスクリプションの契約メニューを元にエンドユーザーがWebサービス上で契約をし、実際の利用量がZuoraに連携されます。
• Zuoraが登録された契約内容から発生する費用を自動で計算して、請求情報を作成します。
• Zuoraが売掛金の回収作業のトリガーをキックします。上図では、実際の回収作業は別のWeb決済代行サービスに委託しています。
• ZuoraとWeb決済代行サービス・社内会計システムの間をHULFT Squareがデータ連携します。

検証内容

• Zuoraが算出した請求書の請求金額の取得(上図の④と⑤の操作に該当します)

HULFT Square設定方法

コネクション設定

名前：任意。今回は「REST接続_zuora_test」と入力しました。
ワークスペース：任意

プロファイル：任意

コネクション設定ができましたら、スクリプトの作成に入ります。
今回作成するスクリプトは、下記のようなスクリプトになります。

• 「create_access_token」でZuoraのOAutn認証に成功するためのアクセストークンを取得
• 「get_invoice」でZuoraの請求書データを取得

create_access_tokenの設定方法

• client_id

初期値：Zuoraのユーザー設定で確認したクライアントIDを入力します。

• client_secret

初期値：Zuoraのユーザー設定で確認したクライアントシークレットを入力します。

• grant_type

初期値：「client_credentials」と入力します。

• access_token

初期値：入力しません。後でスクリプトで取得した値を代入します。

• invoice_id

• ※
  このスクリプト変数は「get_invoice」でどの請求書を取得するかを指定するために使用します。

初期値：任意。試験用に、Zuoraの特定の請求書番号を入力してみてください。

変数の準備が終わりましたら、HTTPリクエストの設定をしていきます。
キャンバス右側の「ツールパレット」から「ネットワーク」＞「REST」＞「POST実行」を選択してキャンバス内にドラッグします。

必須設定タブ

• 名前：任意。今回は「create_access_token」と入力しています。
• 接続先：コネクション設定で作成した設定を選択します。
• パス：oauth/token
  OAuthのアクセストークンを発行するためのパスになります。
  このパスの詳細については下記ページをご確認ください。
  https://www.zuora.com/developer/api-references/api/operation/createToken/
• エンコード：UTF-8

リクエスト設定タブ

• データ入力元：データ
• データ形式：フォーム
• フォーム設定：client_id,client_secret,grant_typeを追加

レスポンス設定タブ

• データ形式：JSON

出力スキーマに設定するJSONファイルは、下記ページのResponse Samplesからコピーして作成してください。
https://www.zuora.com/developer/api-references/api/operation/createToken/

ここまで作成したら、「完了」をクリックして「create_access_token」の設定を終えます。

次に、「create_access_token」の前に配置するmappingの設定を作成します。

「ツールパレット」の「変換」＞「基本」＞「マッピング」を「craete_access_token」の前に配置してください。
マッピング設定は下記のようになります。

スクリプト変数として準備していた「client_id」「client_secret」「grant_type」を「create_access_token」のリクエストデータとしてマッピングしています。

さらに、「create_access_token」で取得したアクセストークンの値をスクリプト変数「access_token」に保存するために「ツールパレット」の「基本」＞「処理」＞「変数代入」を選択して「create_access_token」の後ろに配置してください。

変数代入の設定は下記のようになります。

「create_access_token」が取得した「access_token」の値をスクリプト変数の「access_token」に連携しています。

最後に、「get_invoice」を作成していきます。
キャンバス右側の「ツールパレット」から「ネットワーク」＞「REST」＞「GET実行」を選択してキャンバス内にドラッグします。

必須設定タブ

名前：任意。今回は「get_invoice」と入力しています。

• 接続先：コネクション設定で作成した設定を選択します。
• パス：/v2/invoices/${invoice_id}
  事前に作成していたスクリプト変数「invoice_id」の値がパスとして入力されます。
  このパスに対してGETリクエストすることで、指定した請求書番号のデータがJSON形式で返され、請求金額もその中に含まれます。
  このパスの詳細については下記ページをご確認ください。
  https://www.zuora.com/developer/api-references/quickstart-api/operation/getInvoice/
• エンコード：UTF-8

レスポンス設定タブ

• データ出力先：ファイル。今回はHULFT Squareのストレージ上に請求書のデータファイルをそのまま生成します。

ヘッダ設定タブ

• リクエストヘッダ：「Authorization」ヘッダとして値「Bearer ${access_token}」を追加します。「create_access_token」で取得してスクリプト変数「access_token」に保存した値がここで使用されます。

以上で、下記スクリプトが完成しているはずです。
実行して、「invoice_id」で指定した請求書番号の請求書データがHULFT Squareのストレージ上に生成されることを確認してみましょう。

おわりに

今回はZuoraで算出された請求金額を取得する方法をご紹介しました。
Zuoraでは他操作もAPI上で受け付けており、公式のAPIリファレンスはこちらになります。
https://www.zuora.com/developer/api-references/api/overview/
また、主なAPIの利用例の一覧も同ページで紹介されています。
https://www.zuora.com/developer/quickstart-api/tutorial/create-products-and-prices/

本記事がサブスクリプションビジネスのための HULFT Square 活用の一助になりましたら幸いです。