2021.03.03
サンプルシナリオ 外部サービス連携
「DocuSign」とAPI連携の初期設定を行うサンプルシナリオ

「DocuSign」とAPI連携を行うために必要な初期設定を行い、認証情報を取得するサンプルシナリオになります。

DocuSignを利用されている環境で、DocuSignとWinActorを連携したい場合に利用します。

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

サンプルシナリオ概要

はじめに

「DocuSign」とAPI連携の初期設定を行うサンプルシナリオ(以降、本サンプルシナリオ)について説明します。

注意事項

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

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

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

  • Chromeブラウザを起動し、DocuSignとAPI連携を行うための認証画面を表示します。
  • 認証後、API連携に必要な情報をダウンロードします。
  • API連携に必要な情報をファイルに出力します。

使用するWinActorモジュール

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

  • ノード/ユーザ/待機ボックス
  • ノード/アクション/クリップボード
  • 02_エラー処理/エラー.ums6
  • 04_自動記録アクション/エミュレーション.ums6
  • 07_文字列操作/01_変形・整形/括弧書きの内側を取り出す.ums6
  • 07_文字列操作/02_切り出し・分割/文字列を前後に分割.ums6
  • 07_文字列操作/03_連結/文字列の連結(2つ).ums6
  • 07_文字列操作/03_連結/文字列の連結(3つ).ums6
  • 07_文字列操作/03_連結/文字列の連結(5つ).ums6
  • 13_ファイル関連/01_テキストファイル操作/テキストファイル書込.ums6
  • 13_ファイル関連/01_テキストファイル操作/テキストファイル読込.ums6
  • 13_ファイル関連/02_ファイル操作/ファイル削除.ums6
  • 13_ファイル関連/05_ファイル名/シナリオフォルダのファイルパス.ums6
  • 23_ブラウザ関連/ブラウザ起動(プロキシ設定).ums6
  • 23_ブラウザ関連/ページ表示.ums6
  • 23_ブラウザ関連/ウィンドウハンドル取得.ums6
  • 23_ブラウザ関連/任意のウィンドウへ移動.ums6
  • 99_外部サービス連携/02_HTTP関連/HTTP.ums6
  • プチライブラリ/指定されたファイルをBase64でエンコードするライブラリ.ums6
    (プチライブラリはこちらからダウンロードできます。)

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

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

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

動作確認環境

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

  • Windows 10、WinActor 6.3.0、GoogleChrome 88.0.4324.150
  • Windows 10、WinActor 7.2.0、GoogleChrome 88.0.4324.150

制約事項

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

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

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

Step1.DocuSign事前設定

本サンプルシナリオではシナリオ実行前の手順としてDocuSignを操作する必要があります。

DocuSignへのログイン、設定画面を表示
DocuSignを開いてログインを行ってください。ログイン後、上部メニューから「設定」をクリックしてください。

1_1_DS_login.png

DocuSign ホーム画面



アプリケーションの登録
設定画面の左側メニューから「アプリとキー」をクリックします。

1_2_DS_config.png

DocuSign 設定画面



「アプリとキー」画面が表示されたら、「アプリとインテグレーションキーの追加」ボタンをクリックします。

1_3_DS_add_apps.png

アプリとインテグレーションキーの追加



「APIインテグレーションキーの追加」ダイアログが表示されるので、適当なアプリ名を入力して「追加」ボタンを押下します。

1_4_DS_dialog.png

インテグレーションキーの追加ダイアログ



アプリケーションの詳細画面を表示
追加したアプリケーション名をクリックし、アプリケーションの詳細画面を表示します。

1_5_DS_appedit.png

アプリの編集



インテグレーションキーと秘密鍵の取得
アプリの詳細画面に遷移し、インテグレーションキーをコピーしてメモしてください。
また、「秘密鍵の追加」ボタンをクリックして秘密鍵を生成し、コピーしてメモしてください。

1_6_DS_getkey.png

インテグレーションキーと秘密鍵の取得



リダイレクトURIの設定
同じくアプリの編集ページ下部にある「URIの追加」ボタンをクリックし、追加された入力欄に任意のlocalhostアドレス(例:http://localhost:8080/ds)を入力してください。

1_7_DS_uri.png

リダイレクトURIの設定

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

任意のディレクトリに本サンプルシナリオのシナリオファイルを配置します。
配置した後、WinActorでシナリオファイルを読み込みます。

Step3.動作に必要な変数を設定

本サンプルシナリオを実行するために必要な値を、変数一覧で設定します。
本サンプルシナリオの実行にあたり、事前に設定が必要な変数は下記の通りです。

  • インテグレーションキー
    • Step1でメモしたインテグレーションキーを転記します。

  • 秘密鍵
    • Step1でメモした秘密鍵を転記します。

  • リダイレクトURI
    • Step1で設定したリダイレクトURIを指定します。

1_8_variables.png

本サンプルシナリオ変数一覧の設定

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

本サンプルシナリオを実行します。
実行すると、シナリオの途中でダイアログが表示されます。

1_9_dialog.png

シナリオ実行後のダイアログ

Step5.DocuSignへのログインを実行

Step4のダイアログが表示された後、ChromeブラウザでDocuSignへのログインページが表示されます。
必要な情報を入力してログインを実行してください。

ログイン実行後、エラー画面が表示されます。この状態になったら、Step4で表示されたダイアログのOKボタンをクリックしてください。この時、Chromeブラウザは閉じないでください。

1_10_404.png

ログイン実行後に表示される画面

Step6.サンプルシナリオ実行終了後の確認

ダイアログのOKボタンをクリックすると、シナリオ処理が再開されます。
シナリオ実行終了後、シナリオファイルと同じフォルダに以下の3つのファイルが作成されていることを確認してください。

  • リフレッシュトークン.txt
  • Basic認証キー.txt
  • アクセストークン.txt

トラブルシューティング

認証後の処理ではウィンドウ識別情報を用いた処理を行っていますが、本サンプルシナリオで利用しているウィンドウ識別情報はURLにlocalhostを指定した場合を前提としています。
うまく動作しない場合は、「ウィンドウ識別ルール」からウィンドウ識別情報を新たに取得して更新していただくと動作する場合があります。

troubleshoot_1.png

ウィンドウ識別ルールから新しくウィンドウ識別情報を取得する

サンプルシナリオ解説

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

認証後の画面から認証情報を取得する

本サンプルシナリオの使い方Step5で、ChromeブラウザのページからURLをコピーして解析する処理を行っています。
URLのコピーにはキーエミュレーションを利用して「Ctrl+L」コマンドを実行するようにしています。多くのブラウザは、このコマンドでURL欄を選択することができます。

14471_tech_1.png

URL欄コピーのキーエミュレーション

変更履歴

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

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

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

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