SigningHub (プレビュー)
SigningHub は、ドキュメント承認ワークフロー、高度なデジタル署名、およびドキュメントの状態追跡のための完全なソリューションです。 企業がビジネス ドキュメントを配信、確認、承認、署名する方法を迅速に最適化するように設計されています
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| support@ascertia.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Ascertia |
| Web サイト | https://www.signinghub.com |
| プライバシー ポリシー | https://www.signinghub.com/privacy-policy/ |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
|
Signing |
SigningHub インスタンスの詳細を取得する |
| コンテクトを取得する |
SigningHub からログイン ユーザーに関連する連絡先の一覧を取得する |
| テンプレートの適用 |
指定されたテンプレートをドキュメント ワークフローに適用する |
| テンプレートを取得する |
SigningHub からすべてのエンタープライズ テンプレートの一覧を取得する |
| ドキュメント ワークフローを共有する |
ドキュメント ワークフローを受信者と共有する |
| ドキュメントに署名する |
ログインユーザーによるドキュメントへの署名 |
| ドキュメントを承認する |
受信者は、このターンでワークフローを承認できます |
| ドキュメントを辞退する |
受信者は自分のターンでワークフローを拒否できます |
| ワークフローから受信者を削除する |
既存のワークフローから特定の受信者を削除する |
| ワークフローから特定のドキュメントをダウンロードする |
既存のワークフローから特定のドキュメントをダウンロードする |
| ワークフローにドキュメントをアップロードする |
既存のワークフローにドキュメントをアップロードする |
| ワークフローのすべてのドキュメントをダウンロードする |
SigningHub から既存のワークフローの抽出/圧縮形式ですべてのドキュメントをダウンロードする |
| ワークフローの削除 |
ワークフロー所有者による既存のワークフローの削除 |
| ワークフローの詳細を取得する |
ワークフローの詳細を取得する |
| ワークフローを作成する |
SigningHub 内に新しいワークフローを作成する |
| ワークフローを取得する |
ログイン ユーザーの SigningHub からワークフローの一覧を取得する |
| ワークフローを完了する (途中で終了) |
ワークフロー所有者は、任意の段階でワークフローを完了して終了できます |
| 受信者を取得する |
既存のワークフローの受信者の一覧を取得する |
| 受信者を追加する |
既存のワークフローに受信者を追加する |
SigningHub について
SigningHub インスタンスの詳細を取得する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
建築する
|
aboutSigningHub.build | string |
SigningHub インスタンスのビルド |
|
著作権
|
aboutSigningHub.copyright | string |
SigningHub の著作権 |
|
インストール名
|
aboutSigningHub.installation_name | string |
SigningHub インスタンスのインストール名 |
|
米国特許第
|
aboutSigningHub.patents.us_patent_no | string |
米国特許第の SigningHub |
|
バージョン
|
aboutSigningHub.version | string |
SigningHub インスタンスのバージョン |
コンテクトを取得する
SigningHub からログイン ユーザーに関連する連絡先の一覧を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Enterprise
|
enterprise | boolean |
エンタープライズ連絡先の一覧 |
|
|
ページ番号。
|
pageNo | True | integer |
ページの番号 |
|
1 ページあたりのレコード数
|
recordsPerPage | True | integer |
1 ページあたりのレコード数 |
|
テキストを検索する
|
searchText | string |
リストを除外する検索テキスト |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ユーザーの電子メール
|
user_email | string |
ユーザーの電子メール |
|
ユーザー名
|
user_name | string |
ユーザーの名前 |
|
ユーザーの国 ID
|
user_national_id | string |
ユーザーの国 ID |
テンプレートの適用
指定されたテンプレートをドキュメント ワークフローに適用する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
ドキュメント ID
|
documentId | True | integer |
ドキュメントの ID |
|
すべてに適用
|
applyToAll | True | boolean |
すべてのドキュメントに適用 |
|
テンプレート名
|
templateName | True | string |
適用されたテンプレートの名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Certify enabled
|
applyTemplate.certify.enabled | boolean |
サーティフィケーションが有効な値 |
|
アクセス許可を認定する
|
applyTemplate.certify.permission | string |
certify 権限の値 |
|
ドキュメントの高さ
|
applyTemplate.document_height | integer |
ドキュメントの高さ |
|
ドキュメント ID
|
applyTemplate.document_id | integer |
ドキュメントの ID |
|
ドキュメント名
|
applyTemplate.document_name | string |
ドキュメントの名前 |
|
ドキュメントの順序
|
applyTemplate.document_order | integer |
ワークフロー内のドキュメントの順序 |
|
ドキュメント ページ
|
applyTemplate.document_pages | integer |
ドキュメントの合計ページ数 |
|
ドキュメント ソース
|
applyTemplate.document_source | string |
ドキュメントのソース |
|
ドキュメントの種類
|
applyTemplate.document_type | string |
ドキュメントの種類 |
|
ドキュメントの幅
|
applyTemplate.document_width | integer |
ドキュメントの幅 |
|
フォーム フィールド
|
applyTemplate.form_fields | boolean |
ドキュメントのフォーム フィールドの可用性 |
|
フォーム フィールドをロックする
|
applyTemplate.lock_form_fields | boolean |
ロック フォーム フィールドの有効な値 |
|
変更日
|
applyTemplate.modified_on | string |
変更された日付 |
|
読み取り専用
|
applyTemplate.template.read_only | boolean |
テンプレートの準備完了のみの型 |
|
テンプレート名
|
applyTemplate.template.template_name | string |
適用されたテンプレートの名前 |
|
アップロード日
|
applyTemplate.uploaded_on | string |
アップロード日 |
テンプレートを取得する
SigningHub からすべてのエンタープライズ テンプレートの一覧を取得する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
templatesCollection
|
templatesCollection | array of object |
templatesCollection |
|
|
templatesCollection.read_only | boolean |
read_only |
|
template_id
|
templatesCollection.template_id | integer |
template_id |
|
template_name
|
templatesCollection.template_name | string |
template_name |
|
template_public
|
templatesCollection.template_public | boolean |
template_public |
ドキュメント ワークフローを共有する
ドキュメント ワークフローを受信者と共有する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ワークフロー ID
|
packageID | integer |
共有ワークフローの ID |
ドキュメントに署名する
ログインユーザーによるドキュメントへの署名
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
ドキュメント ID
|
documentId | True | integer |
ドキュメントの ID |
|
ページ番号。
|
pageNo | True | integer |
ドキュメント ページの番号 |
|
ページ位置
|
pagePosition | True | string |
ドキュメント ページ上の位置 |
|
ページ X
|
pageX | integer |
ドキュメント ページ上の水平方向の位置 |
|
|
ページ Y
|
pageY | integer |
ドキュメント ページ上の垂直方向の位置 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント名
|
documentName | string |
署名済みドキュメントの名前 |
|
フィールド名
|
fieldName | string |
符号付きフィールドの名前 |
|
ステータス
|
status | string |
署名済みドキュメントの状態 |
ドキュメントを承認する
受信者は、このターンでワークフローを承認できます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
承認理由
|
approveReason | string |
ドキュメントを承認する理由 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
承認されたドキュメント
|
documentApproved | boolean |
承認されたドキュメントの状態 |
ドキュメントを辞退する
受信者は自分のターンでワークフローを拒否できます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
辞退理由
|
declineReason | True | string |
ドキュメントを辞退する理由 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメントが拒否されました
|
documentDeclined | boolean |
ドキュメントの状態が拒否されました |
ワークフローから受信者を削除する
既存のワークフローから特定の受信者を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
注文
|
order | True | integer |
削除された受信者の順序 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受信者が削除されました
|
recipientDeleted | boolean |
受信者が削除された状態 |
ワークフローから特定のドキュメントをダウンロードする
既存のワークフローから特定のドキュメントをダウンロードする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
|
ドキュメント ID
|
documentId | True | integer |
ドキュメントの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメントコンテンツ
|
documentContent | byte |
base64 文字列内のドキュメントの内容 |
|
ドキュメントの種類
|
documentType | string |
ドキュメントの種類 |
ワークフローにドキュメントをアップロードする
既存のワークフローにドキュメントをアップロードする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
既存のワークフローの ID |
|
ドキュメントコンテンツ
|
documentContent | True | byte |
base64 で追加されたドキュメントの内容 |
|
拡張子付きのドキュメント名
|
documentName | True | string |
拡張子を持つ追加されたドキュメントの名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
documentId | string |
アップロードされたドキュメントの ID |
ワークフローのすべてのドキュメントをダウンロードする
SigningHub から既存のワークフローの抽出/圧縮形式ですべてのドキュメントをダウンロードする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークフロー コンテンツ
|
packageContent | byte |
base64 文字列内のワークフローの内容 |
|
ワークフローの種類
|
packageType | string |
ワークフロー コンテンツの種類 |
ワークフローの削除
ワークフロー所有者による既存のワークフローの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークフローが削除されました
|
packageDeleted | boolean |
ワークフローが削除された応答 |
ワークフローの詳細を取得する
ワークフローの詳細を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
書類
|
documents | array of object |
書類 |
|
allowed_permissions
|
documents.certify.allowed_permissions | array of string |
allowed_permissions |
|
default_permission
|
documents.certify.default_permission | string |
default_permission |
|
enabled
|
documents.certify.enabled | boolean |
enabled |
|
created_on
|
documents.created_on | string |
created_on |
|
document_height
|
documents.document_height | integer |
document_height |
|
document_id
|
documents.document_id | integer |
document_id |
|
document_name
|
documents.document_name | string |
document_name |
|
document_order
|
documents.document_order | integer |
document_order |
|
document_pages
|
documents.document_pages | integer |
document_pages |
|
document_source
|
documents.document_source | string |
document_source |
|
document_type
|
documents.document_type | string |
document_type |
|
document_width
|
documents.document_width | integer |
document_width |
|
form_fields
|
documents.form_fields | boolean |
form_fields |
|
lock_form_fields
|
documents.lock_form_fields | boolean |
lock_form_fields |
|
modified_on
|
documents.modified_on | string |
modified_on |
|
テンプレート
|
documents.template | string |
テンプレート |
|
フォルダー
|
folder | string |
フォルダーの種類 |
|
変更日
|
modified_on | string |
変更日 |
|
次の署名者
|
next_signer | string |
次の署名者の電子メール |
|
next_signer_email
|
next_signer_email | array of |
next_signer_email |
|
所有者名
|
owner_name | string |
所有者の表示名 |
|
ワークフロー ID
|
package_id | integer |
ワークフローの ID |
|
ワークフロー名
|
package_name | string |
ワークフローの名前 |
|
ワークフロー所有者
|
package_owner | string |
ワークフローの所有者 |
|
パッケージの状態
|
package_status | string |
ワークフローの現在の状態 |
|
アップロード日
|
uploaded_on | string |
アップロードされたワークフローの日付 |
|
users
|
users | array of |
users |
|
辞退を続ける
|
workflow.continue_on_decline | boolean |
ワークフローの拒否を続行する |
|
contacts
|
workflow.post_process.contacts | array of |
contacts |
|
Dropbox
|
workflow.post_process.dropbox | boolean |
Dropbox の有効な値 |
|
Google ドライブ
|
workflow.post_process.google_drive | boolean |
Google ドライブが有効な値 |
|
ワークフロー受信者
|
workflow.post_process.workflow_recipients | boolean |
ワークフロー受信者の値 |
|
読み取り専用
|
workflow.read_only | boolean |
ワークフローの読み取り専用値 |
|
ワークフロー モード
|
workflow.workflow_mode | string |
ワークフローのモード |
|
ワークフローの状態
|
workflow.workflow_status | string |
ワークフローの状態 |
|
ワークフローの種類
|
workflow.workflow_type | string |
ワークフローの種類 |
ワークフローを作成する
SigningHub 内に新しいワークフローを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメントコンテンツ
|
documentContent | True | string |
base64 のドキュメントの内容 |
|
ワークフロー名
|
documentName | True | string |
SigningHub 内に新しいワークフローを作成する |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
documentId | integer |
ドキュメントの ID |
|
パッケージ識別子
|
packageId | integer |
ワークフローの ID |
ワークフローを取得する
ログイン ユーザーの SigningHub からワークフローの一覧を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメントの状態
|
documentStatus | True | string |
ドキュメントの状態 |
|
フォルダー
|
folder | True | string |
ユーザーのワークフローのフォルダー |
|
ページ番号。
|
pageNo | True | integer |
ドキュメント ページの番号 |
|
1 ページあたりのレコード数
|
recordsPerPage | integer |
1 ページあたりのレコード数 |
|
|
テキストを検索する
|
searchText | string |
リストを除外する検索テキスト |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
フォルダー
|
folder | string |
ユーザーのワークフローのフォルダー |
|
変更日
|
modified_on | string |
変更された日付 |
|
次の署名者
|
next_signer | string |
ワークフローの次の署名者 |
|
next_signer_email
|
next_signer_email | array of object |
next_signer_email |
|
user_email
|
next_signer_email.user_email | string |
user_email |
|
user_name
|
next_signer_email.user_name | string |
user_name |
|
所有者名
|
owner_name | string |
ワークフロー所有者の名前 |
|
ワークフロー ID
|
package_id | integer |
ワークフローの ID |
|
ワークフロー名
|
package_name | string |
ワークフローの名前 |
|
ワークフロー所有者
|
package_owner | string |
ワークフロー所有者の電子メール |
|
ワークフローの状態
|
package_status | string |
ワークフローの状態 |
|
Unread
|
unread | boolean |
未読の種類 |
|
アップロード日
|
uploaded_on | string |
アップロードされたワークフローの日付 |
ワークフローを完了する (途中で終了)
ワークフロー所有者は、任意の段階でワークフローを完了して終了できます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | string |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークフローが完了しました
|
workflowCompleted | boolean |
完了したワークフローの状態 |
受信者を取得する
既存のワークフローの受信者の一覧を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
ワークフローの ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Recipients
|
recipients | array of object |
Recipients |
|
Delegatee
|
recipients.delegatee | string |
代理人の電子メール |
|
委任名
|
recipients.delegatee_name | string |
デリゲートの名前 |
|
グループ名
|
recipients.group_name | string |
グループの名前 |
|
注文
|
recipients.order | integer |
受信者の順序 |
|
Placeholder
|
recipients.placeholder | string |
プレースホルダーの値 |
|
プロセスの状態
|
recipients.process_status | string |
プレースホルダーの状態 |
|
次のように処理されます
|
recipients.processed_as | string |
処理された値 |
|
により処理
|
recipients.processed_by | string |
処理者の電子メール |
|
処理日
|
recipients.processed_on | string |
処理された日付 |
|
理由
|
recipients.reason | string |
ある場合の理由 |
|
Role
|
recipients.role | string |
受信者の役割 |
|
署名順序
|
recipients.signing_order | integer |
署名の順序 |
|
ユーザーの電子メール
|
recipients.user_email | string |
ユーザーの電子メール |
|
ユーザー名
|
recipients.user_name | string |
ユーザーの名前 |
|
ユーザーの国 ID
|
recipients.user_national_id | string |
ユーザーの国 ID |
受信者を追加する
既存のワークフローに受信者を追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
packageId | True | integer |
既存のワークフローの ID |
|
署名フィールドの追加
|
addSignatureField | True | boolean |
ワークフローに署名フィールドを追加する |
|
ドキュメント ID
|
documentId | integer |
ドキュメントの ID |
|
|
電子メール通知
|
emailNotification | True | boolean |
電子メール通知 |
|
自分のみ
|
onlyMe | boolean |
自分だけの受信者の種類 |
|
|
ページ番号。
|
pageNo | integer |
ドキュメント ページの番号 |
|
|
ページ位置
|
pagePosition | True | string |
ページ上の位置 |
|
ページ X
|
pageX | integer |
ドキュメント ページ上の水平方向の位置 |
|
|
ページ Y
|
pageY | integer |
ドキュメント ページ上の垂直方向の位置 |
|
|
Role
|
role | True | string |
受信者の役割 |
|
署名順序
|
signingOrder | True | integer |
受信者の署名の順序 |
|
ユーザーの電子メール
|
userEmail | True | string |
受信者の電子メール |
|
ユーザー名
|
userName | True | string |
受信者の名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受信者の追加
|
recipientAdded | boolean |
受信者が応答を追加しました |