2021.04.28
サンプルシナリオ 外部サービス連携
「DocuSign」とAPI連携でドキュメントのアップロードをするサンプルシナリオ

「DocuSign」とAPI連携し、ドキュメントをアップロードし、指定したテンプレートを適用して署名依頼を実行するサンプルシナリオになります。

DocuSignを利用されている環境で、テンプレートの決まったドキュメントの署名依頼を自動処理したい場合に利用します。

本サンプルシナリオをダウンロードする前にこちらの注意事項を必ずご確認ください。

サンプルシナリオ概要

はじめに

「DocuSign」とAPI連携でドキュメントのダウンロードをするサンプルシナリオ(以降、本サンプルシナリオ)について説明します。

注意事項

本サンプルシナリオ利用時の注意事項はこちらです。

本サンプルシナリオの概要

本サンプルシナリオは、以下の処理を行います。

  • DocuSignとAPI連携し、アクセストークンの確認を行います。
  • アクセストークンの有効期限が切れていた場合、再発行処理を行います。
  • DocuSignとAPI連携し、ドキュメントの情報取得とファイルダウンロードを実行します。

使用するWinActorモジュール

本サンプルシナリオでは、以下のWinActorモジュールを使用します。

  • ノード/変数/変数値コピー
  • 02_エラー処理/エラー.ums6
  • 07_文字列操作/01_変形・整形/括弧書きの内側を取り出す.ums6
  • 07_文字列操作/03_連結/文字列の連結(2つ).ums6
  • 07_文字列操作/03_連結/文字列の連結(3つ).ums6
  • 13_ファイル関連/01_テキストファイル操作/テキストファイル書込.ums6
  • 13_ファイル関連/01_テキストファイル操作/テキストファイル読込.ums6
  • 13_ファイル関連/02_ファイル操作/ファイル削除.ums6
  • 13_ファイル関連/02_ファイル操作/ファイル存在有無チェック.ums6
  • 13_ファイル関連/05_ファイル名/シナリオフォルダのファイルパス.ums6
  • 98_構造データ関連/01_JSON/JSONファイル 配列読み取り.ums6
  • 98_構造データ関連/01_JSON/JSON変数 読み取り.ums6
  • 98_構造データ関連/01_JSON/JSON変数 新規配列.ums6
  • 98_構造データ関連/01_JSON/JSON変数 新規オブジェクト.ums6
  • 98_構造データ関連/01_JSON/JSON変数 要素追加.ums6
  • 98_構造データ関連/01_JSON/JSON変数 配列要素追加.ums6
  • 99_外部サービス連携/02_HTTP関連/HTTP.ums6
  • プチライブラリ/指定されたファイルをBase64でエンコードするライブラリ
    (プチライブラリはこちらからダウンロードできます)
  • スイートライブラリ/ファイルパスからファイル名と拡張子を取得
    (スイートライブラリはこちらからダウンロードできます)

本サンプルシナリオの想定レベル

本ドキュメントは、以下の技術レベルのユーザを対象としています。

  • DocuSignの使い方について理解している。

動作確認環境

本サンプルシナリオは以下の環境で確認しています。

  • Windows 10、WinActor 6.3.0
  • Windows 10、WinActor 7.2.0

制約事項

  • 本サンプルシナリオを実行するためには、DocuSignにアクセスするためのインターネット環境が必要です。
  • 本サンプルシナリオおよびドキュメントは、DocuSignにログインできる状態を前提に記載されています。

本サンプルシナリオの使い方

本サンプルシナリオの実施方法は以下の通りです。

Step1.シナリオ実行事前設定

本サンプルシナリオではシナリオ実行前の手順として、「「DocuSign」とAPI連携の初期設定を行うサンプルシナリオ」を実行し、「Basic認証キー.txt」「アクセストークン.txt」「リフレッシュトークン.txt」を生成しておく必要があります。


Step2.テンプレートIDの取得

DocuSignから、本シナリオでアップロードするドキュメントに適用するテンプレートのIDを取得します。
DocuSignにアクセスし、上部メニューから「テンプレート」をクリックします。

15061_2-1.png
テンプレートのクリック


テンプレート一覧から、本シナリオで適用するテンプレートを選び、クリックします。

15061_2-2.png
対象のテンプレートを選択



テンプレートIDをクリックすると、IDがポップアップで表示されます。後ほどシナリオ変数に設定するため、メモしておいてください。

15061_2-3.png
テンプレートIDのコピー



Step3.WinActorで本サンプルシナリオを読み込み

任意のディレクトリに本サンプルシナリオのシナリオファイルとStep1で生成した「Basic認証キー.txt」「アクセストークン.txt」「リフレッシュトークン.txt」を配置します。
その後、本サンプルシナリオをWinActorで読み込みます。


Step4.動作に必要な変数の設定・確認

本サンプルシナリオを実行するために必要な値を、変数一覧で設定・変更します。

以下の変数を必要に応じて設定・変更してください。

  • テンプレートID
    • Step2で取得したテンプレートIDを設定してください。

  • 登録ファイルパス
    • Step3で配置した、読み取り対象ファイルのファイルパスを設定してください。

15061_4-1.png
変数一覧画面



Step5.WinActorで本サンプルシナリオを実行

本サンプルシナリオを実行します。
シナリオ実行後、テンプレートに設定された署名者宛に、署名依頼メールが送信されます。


トラブルシューティング

本サンプルシナリオでは、HTTPリクエストを使用しています。
シナリオ実行中にエラーが表示される場合はお手数ですが、WinActor本体のプロキシ設定のご確認や、「応答ステータス」変数の値に格納されたレスポンスステータスコードのご確認をお願いします。

サンプルシナリオ解説

本サンプルシナリオで使用している実装テクニックについて説明します。

複数のドキュメントを処理したい場合

ドキュメントを送信するための前処理は、以下の画像の赤枠部分に該当します。複数のドキュメントを登録したい場合は、この処理をドキュメントごとに実施する必要があります。
ドキュメントIDは現状1固定ですが、ドキュメント数を増やす場合はそれぞれにIDを設定してください。

15061_tech_1.png
ドキュメントの登録処理



ドキュメントの送信設定

ドキュメント作成後、署名者にメールを送らず下書きとして保存したい場合は、HTTPノードの「要求」タブから、「status」キーを削除してください。
メール送信しない場合でも、エンベロープは消費されますのでご注意ください。

15061_tech_2.png
署名依頼の中止

変更履歴

版数日付修正内容
版数
1.0版
日付
2021/4/28
修正内容
初版

本サンプルシナリオをダウンロードする前にこちらの注意事項を必ずご確認ください。

"外部サービス連携"に関連するその他のサンプルシナリオ

サンプルシナリオ一覧へ戻る
このウェブサイトでは、お客様に最適なユーザー体験を向上するためにCookieを使用しています。
本サイトをご利用いただくことにより、お客様がCookieの使用に同意されたものとみなします。
弊社のCookieの使用に関する方針の詳細は、
「プライバシーポリシー」をご確認ください。