Zoho Sign
Zoho's Sign は、完全なセキュリティと信頼性を備えたビジネス ドキュメントのデジタル署名を支援する完全なデジタル署名アプリです
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Zoho Sign API サポート |
[URL] | https://www.zoho.com/sign/contact.html |
メール | support@zohosign.com |
Connector Metadata | |
---|---|
発行者 | Zoho Corporation |
Web サイト | https://www.zoho.com/sign/ |
プライバシー ポリシー | https://www.zoho.com/privacy.html |
カテゴリー | コンテンツとファイル;生産性 |
Zoho の電子署名ソフトウェアを使用して、完全なセキュリティと信頼性でビジネスドキュメントにオンラインでデジタル署名します。 シンプルな電子署名ドキュメント ワークフローでトランザクションを自動化します。 ビジネス署名者向けの完全なデジタル署名アプリ。
前提条件
このコネクタを使用するには、Zoho-Sign プラットフォームの有料の Zoho-Sign アカウントが必要です。 詳細については、https://www.zoho.com/sign/pricing-api.html を参照してください ここで https://zoho.com/sign アカウントを設定することもできます ##資格情報の入手方法 Zoho-Sign API は、OAuth 2 を使用して認証します。 したがって、アカウントが設定されると、追加の手順は必要ありません。
すべての Zoho Sign API には、次の必須ヘッダーが必要です: 承認 - 認証リクエストヘッダー。
トークンの生成については、以下を参照してください:
https://www.zoho.com/sign/api/#getting-started
コネクタの使用を開始する
Zoho Sign Connector は、ユーザーが Zoho Sign のWeb インターフェイスにアクセスせずに、ドキュメント管理、テンプレート管理、およびその他の操作を直接実行するためのオプションを提供します
ドキュメント管理では、これらのコネクタを使用して、ユーザーはドキュメントの作成、ドキュメントの更新、署名用のドキュメントの送信、およびアカウントに関連するすべてのドキュメントのリストの取得を行うことができます。
同様に他の操作については、「サポートされている操作は何ですか?」を参照してください 以下のリンクのタイトル、
https://www.zoho.com/sign/api/#introduction
これらのコネクタは、ドキュメントやテンプレートの送信から状態追跡などに至るまで、使用を自動化するのに役立ちます。
一般的なエラーと解決策
エラーが発生した場合は、適切なエラー コードとその理由を使用してデバッグしてください。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
地域を選択します。 | string | ドメインを選択します。 | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
Send |
アップロードしたドキュメントを署名用に送信 |
テンプレートのリストを取得 |
テンプレートのリスト |
ドキュメントの取得 |
特定のドキュメントの詳細を取得します |
ドキュメントをダウンロードする |
選択されたドキュメントをダウンロード |
ドキュメントを削除する |
特定のドキュメントを削除する |
ファイルのダウンロード |
選択した特定のドキュメントをダウンロードします。 |
作成されたリクエストのプロパティを更新 |
作成されたリクエストのプロパティを更新 |
受信者へのリマインダー |
特定のドキュメントの受信者にリマインダーを送信します。 |
完了したリクエストのデータを取得する |
完了したリクエストのデータを取得する |
完了証明書をダウンロード |
完了証明書をダウンロード |
特定のテンプレートの詳細を取得する |
特定のテンプレートの詳細を取得する |
特定のドキュメントを取り消す |
特定のドキュメントを取り消す |
署名用のドキュメントを作成する |
ファイルをアップロードして署名用のドキュメントを作成するアクション。 |
SendSignRequest
アップロードしたドキュメントを署名用に送信
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
RequestId | True | string |
要求 ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | integer |
code |
メッセージ
|
message | string |
メッセージ |
状態
|
status | string |
状態 |
テンプレートのリストを取得
テンプレートのリスト
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
テンプレート
|
templates | array of object | |
template_id
|
templates.template_id | string | |
template_name
|
templates.template_name | string |
テンプレート名 |
ドキュメントの取得
特定のドキュメントの詳細を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
RequestId | True | integer |
要求 ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | integer |
code |
request_status
|
requests.request_status | string |
要求の状態 |
メモ
|
requests.notes | string |
メモ |
添付ファイル
|
requests.attachments | array of |
添付ファイル |
reminder_period
|
requests.reminder_period | integer |
リマインダー期間 |
owner_id
|
requests.owner_id | string |
所有者 ID |
説明
|
requests.description | string |
要求の説明 |
request_name
|
requests.request_name | string |
要求の名前 |
modified_time
|
requests.modified_time | integer |
変更時刻 |
action_time
|
requests.action_time | integer |
アクション時刻 |
is_deleted
|
requests.is_deleted | boolean |
要求の削除状態 |
expiration_days
|
requests.expiration_days | integer |
有効期限 |
is_sequential
|
requests.is_sequential | boolean |
シーケンスの状態 |
sign_submitted_time
|
requests.sign_submitted_time | integer |
署名送信時刻 |
owner_first_name
|
requests.owner_first_name | string |
所有者の名 |
sign_percentage
|
requests.sign_percentage | float |
サインの割合 |
expire_by
|
requests.expire_by | integer |
ドキュメントの有効期限 |
is_expiring
|
requests.is_expiring | boolean |
ドキュメントの有効期限 |
owner_email
|
requests.owner_email | string |
所有者のメール ID |
created_time
|
requests.created_time | integer |
ドキュメントが作成された時刻 |
email_reminders
|
requests.email_reminders | boolean |
メールでリマインダーを送信 |
document_ids
|
requests.document_ids | array of object |
ドキュメント ID |
image_string
|
requests.document_ids.image_string | string |
画像文字列 |
document_name
|
requests.document_ids.document_name | string |
ドキュメント名 |
ページ
|
requests.document_ids.pages | array of object |
ページ |
image_string
|
requests.document_ids.pages.image_string | string |
画像文字列 |
ページ
|
requests.document_ids.pages.page | integer |
ページ |
is_thumbnail
|
requests.document_ids.pages.is_thumbnail | boolean |
サムネイルのステータス |
document_size
|
requests.document_ids.document_size | integer |
ドキュメントのサイズ |
document_order
|
requests.document_ids.document_order | string |
ドキュメントの順序 |
total_pages
|
requests.document_ids.total_pages | integer |
ドキュメントの合計ページ数 |
document_id
|
requests.document_ids.document_id | string |
Document Id |
self_sign
|
requests.self_sign | boolean |
自己署名の状態 |
sign_id
|
requests.sign_id | string |
署名 ID |
folder_name
|
requests.folder_name | string |
フォルダーの名前 |
in_process
|
requests.in_process | boolean |
処理中状態 |
有効性
|
requests.validity | integer |
ドキュメントの有効性 |
request_type_name
|
requests.request_type_name | string |
要求の種類名 |
folder_id
|
requests.folder_id | string |
フォルダー ID |
request_id
|
requests.request_id | string |
要求 ID |
request_type_id
|
requests.request_type_id | string |
要求タイプ ID |
owner_last_name
|
requests.owner_last_name | string |
所有者の姓 |
アクション
|
requests.actions | array of object |
アクション |
verify_recipient
|
requests.actions.verify_recipient | boolean |
受信者メール ID の検証 |
action_type
|
requests.actions.action_type | string |
アクションの種類 |
private_notes
|
requests.actions.private_notes | string |
非公開メモ |
recipient_email
|
requests.actions.recipient_email | string |
受信者のメール ID |
send_completed_document
|
requests.actions.send_completed_document | boolean |
送信完了ドキュメントのステータス |
verification_type
|
requests.actions.verification_type | string |
検証タイプ |
allow_signing
|
requests.actions.allow_signing | boolean |
署名の状態を許可 |
recipient_phonenumber
|
requests.actions.recipient_phonenumber | string |
受信者の電話番号 |
is_bulk
|
requests.actions.is_bulk | boolean |
一括の状態 |
action_id
|
requests.actions.action_id | string |
アクション ID |
is_revoked
|
requests.actions.is_revoked | boolean |
取り消しの状態 |
is_embedded
|
requests.actions.is_embedded | boolean |
埋め込みのステータス |
signing_order
|
requests.actions.signing_order | integer |
署名順序 |
recipient_name
|
requests.actions.recipient_name | string |
受信者名 |
action_status
|
requests.actions.action_status | string |
アクションの状態 |
recipient_countrycode
|
requests.actions.recipient_countrycode | string |
受信者の国コード |
ishost
|
requests.actions.ishost | boolean |
ホスト用途の状態 |
language
|
requests.actions.language | string |
言語 |
in_person_name
|
requests.actions.in_person_name | string |
個人名 |
in_person_email
|
requests.actions.in_person_email | string |
個人のメール |
verification_code
|
requests.actions.verification_code | string |
確認コード |
attachment_size
|
requests.attachment_size | integer |
添付ファイルのサイズ |
メッセージ
|
message | string |
メッセージ |
状態
|
status | string |
状態 |
ドキュメントをダウンロードする
ドキュメントを削除する
特定のドキュメントを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
request_id | True | integer |
要求 ID |
ファイルのダウンロード
選択した特定のドキュメントをダウンロードします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
request_id | True | integer |
要求 ID |
ドキュメント ID
|
document_id | True | integer |
ドキュメント ID |
戻り値
- 応答
- file
作成されたリクエストのプロパティを更新
作成されたリクエストのプロパティを更新
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
RequestId | True | string |
要求 ID |
ドキュメントのタイプ
|
request_type_id | string |
request_type_id |
|
ドキュメント名
|
request_name | True | string |
ドキュメントの名前 (要求) |
受取人の名前
|
recipient_name | string |
受信者名 |
|
受信者のメール
|
recipient_email | string |
受信者のメール |
|
電話番号
|
recipient_phonenumber | string |
SMS 認証モードの受信者の電話番号。 |
|
国番号
|
recipient_countrycode | string |
SMS 認証モードの受信者の電話番号の国番号。 |
|
ActionType
|
action_type | string |
受信者が署名者、閲覧者、承認者、または inpersonSigner のいずれであるかを選択します。 |
|
非公開メモ
|
private_notes | string |
非公開メモ |
|
署名順序
|
signing_order | integer |
署名順序 |
|
受信者の認証が必要
|
verify_recipient | boolean |
受信者を認証モードの 1 つで検証する必要があるかどうかです。 |
|
認証提供タイプ
|
verification_type | string |
検証タイプ |
|
確認コード
|
verification_code | string |
オフライン検証モードの 6 桁の確認コード。 |
|
所要日数
|
expiration_days | integer |
ドキュメントの有効期限が切れるまでの残り日数。 |
|
順番に送信
|
is_sequential | boolean |
受信者が指定された順序でログインできるようにします。 |
|
自動アラーム
|
email_reminders | boolean |
受信者がドキュメントに署名するための定期的なリマインダーを有効にします。 |
|
- (日) ごとにアラームを送信
|
reminder_period | integer |
署名のリマインダーが受信者に送信される時間間隔を指定します。 |
|
フォルダー
|
folder_id | string |
フォルダの一意の ID |
|
メモ
|
notes | html |
すべての受信者へのメモ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | integer |
code |
メッセージ
|
message | string |
メッセージ |
状態
|
status | string |
状態 |
受信者へのリマインダー
特定のドキュメントの受信者にリマインダーを送信します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
request_id | True | integer |
要求 ID |
完了したリクエストのデータを取得する
完了したリクエストのデータを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
request_id | True | integer |
要求 ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | integer |
コード |
request_name
|
document_form_data.request_name | string |
要求名 |
zsdocumentid
|
document_form_data.zsdocumentid | string |
Zoho Sign ドキュメント ID |
アクション
|
document_form_data.actions | array of object |
アクション |
signed_time
|
document_form_data.actions.signed_time | string |
署名時刻 |
action_type
|
document_form_data.actions.action_type | string |
アクションの種類 |
recipient_email
|
document_form_data.actions.recipient_email | string |
受信者のメール |
recipient_name
|
document_form_data.actions.recipient_name | string |
受信者名 |
フィールド
|
document_form_data.actions.fields | array of object |
フィールド |
field_label
|
document_form_data.actions.fields.field_label | string |
フィールド ラベル |
field_value
|
document_form_data.actions.fields.field_value | string |
フィールド値 |
field_name
|
document_form_data.actions.fields.field_name | string |
フィールド名 |
状態
|
status | string |
状態 |
完了証明書をダウンロード
特定のテンプレートの詳細を取得する
特定のテンプレートの詳細を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テンプレートのリスト
|
template_id | True | string |
テンプレートのリスト |
特定のドキュメントを取り消す
特定のドキュメントを取り消す
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
要求 ID
|
request_id | True | integer |
要求 ID |
署名用のドキュメントを作成する
ファイルをアップロードして署名用のドキュメントを作成するアクション。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ドキュメントを作成する
|
file | True | file |
ドキュメントを作成する |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | integer |
code |
request_status
|
requests.request_status | string |
要求の状態 |
owner_email
|
requests.owner_email | string |
所有者のメール |
created_time
|
requests.created_time | integer |
作成時刻 |
document_ids
|
requests.document_ids | array of object |
document_ids |
image_string
|
requests.document_ids.image_string | string |
画像文字列 |
document_name
|
requests.document_ids.document_name | string |
ドキュメント名 |
ページ
|
requests.document_ids.pages | array of object |
ページ |
image_string
|
requests.document_ids.pages.image_string | string |
画像文字列 |
ページ
|
requests.document_ids.pages.page | integer |
ページ |
is_thumbnail
|
requests.document_ids.pages.is_thumbnail | boolean |
is_thumbnail |
document_size
|
requests.document_ids.document_size | integer |
ドキュメント サイズ |
document_order
|
requests.document_ids.document_order | string |
ドキュメントの順序 |
total_pages
|
requests.document_ids.total_pages | integer |
合計ページ数 |
document_id
|
requests.document_ids.document_id | string |
ドキュメント ID |
メモ
|
requests.notes | string |
メモ |
self_sign
|
requests.self_sign | boolean |
自己署名 |
owner_id
|
requests.owner_id | string |
所有者 ID |
説明
|
requests.description | string |
説明 |
folder_name
|
requests.folder_name | string |
フォルダー名 |
request_name
|
requests.request_name | string |
要求名 |
modified_time
|
requests.modified_time | integer |
変更された時間 |
is_deleted
|
requests.is_deleted | boolean |
削除の状態 |
expiration_days
|
requests.expiration_days | integer |
有効期限 |
in_process
|
requests.in_process | boolean |
処理中 |
is_sequential
|
requests.is_sequential | boolean |
シーケンスの状態 |
request_type_name
|
requests.request_type_name | string |
要求の種類名 |
owner_first_name
|
requests.owner_first_name | string |
所有者の名 |
folder_id
|
requests.folder_id | string |
フォルダー ID |
request_id
|
requests.request_id | string |
要求 ID |
request_type_id
|
requests.request_type_id | string |
要求タイプ ID |
owner_last_name
|
requests.owner_last_name | string |
所有者の姓 |
sign_percentage
|
requests.sign_percentage | integer |
サインの割合 |
メッセージ
|
message | string |
メッセージ |
ステータス
|
status | string |
ステータス |
トリガー
Zoho Sign トリガー |
特定のイベントのコールバックを登録 |
Zoho Sign トリガー
特定のイベントのコールバックを登録
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アクション
|
webhook_actions | True | string |
Webhook アクション |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
request_status
|
requests.request_status | string |
要求の状態 |
メモ
|
requests.notes | string |
メモ |
reminder_period
|
requests.reminder_period | integer |
リマインダー期間 |
owner_id
|
requests.owner_id | string |
所有者 ID |
説明
|
requests.description | string |
説明 |
request_name
|
requests.request_name | string |
要求名 |
modified_time
|
requests.modified_time | integer |
変更時刻 |
action_time
|
requests.action_time | integer |
アクション時刻 |
is_deleted
|
requests.is_deleted | boolean |
削除済みの状態 |
expiration_days
|
requests.expiration_days | integer |
有効期限 |
is_sequential
|
requests.is_sequential | boolean |
連続する操作の状態 |
sign_submitted_time
|
requests.sign_submitted_time | integer |
署名送信時刻 |
owner_first_name
|
requests.owner_first_name | string |
名の所有者 |
sign_percentage
|
requests.sign_percentage | integer |
サインの割合 |
expire_by
|
requests.expire_by | integer |
有効期限 |
owner_email
|
requests.owner_email | string |
所有者のメール |
created_time
|
requests.created_time | integer |
作成時刻 |
email_reminders
|
requests.email_reminders | boolean |
メール アラーム |
document_ids
|
requests.document_ids | array of object |
ドキュメント ID の一覧 |
document_name
|
requests.document_ids.document_name | string |
ドキュメント名を入力 |
document_size
|
requests.document_ids.document_size | integer |
ドキュメントのサイズ |
document_order
|
requests.document_ids.document_order | string |
ドキュメントの順序 |
total_pages
|
requests.document_ids.total_pages | integer |
ドキュメント内の合計ページ数 |
document_id
|
requests.document_ids.document_id | string |
ドキュメント ID |
self_sign
|
requests.self_sign | boolean |
自己署名の状態 |
in_process
|
requests.in_process | boolean |
処理中の状態 |
有効性
|
requests.validity | integer |
有効性 |
request_type_name
|
requests.request_type_name | string |
要求の種類名 |
decline_reason
|
requests.decline_reason | string |
拒否理由 |
request_id
|
requests.request_id | string |
要求 ID |
request_type_id
|
requests.request_type_id | string |
要求タイプ ID |
owner_last_name
|
requests.owner_last_name | string |
所有者の姓 |
アクション
|
requests.actions | array of object |
アクション |
verify_recipient
|
requests.actions.verify_recipient | boolean |
受信者の検証 |
action_type
|
requests.actions.action_type | string |
アクションの種類 |
private_notes
|
requests.actions.private_notes | string |
非公開メモ |
recipient_email
|
requests.actions.recipient_email | string |
受信者のメール |
allow_signing
|
requests.actions.allow_signing | boolean |
署名の状態 |
recipient_phonenumber
|
requests.actions.recipient_phonenumber | string |
受信者の電話番号 |
is_bulk
|
requests.actions.is_bulk | boolean |
一括アクションの状態 |
action_id
|
requests.actions.action_id | string |
アクション ID |
is_revoked
|
requests.actions.is_revoked | boolean |
取り消しの状態 |
is_embedded
|
requests.actions.is_embedded | boolean |
埋め込みのステータス |
signing_order
|
requests.actions.signing_order | integer |
署名順序 |
recipient_name
|
requests.actions.recipient_name | string |
受信者名 |
action_status
|
requests.actions.action_status | string |
アクションの状態 |
recipient_countrycode
|
requests.actions.recipient_countrycode | string |
受信者の国番号 |
performed_by_email
|
notifications.performed_by_email | string |
メールで実行 |
performed_at
|
notifications.performed_at | integer |
実行日時 |
理由
|
notifications.reason | string |
理由 |
活動
|
notifications.activity | string |
活動 |
operation_type
|
notifications.operation_type | string |
操作の種類 |
action_id
|
notifications.action_id | string |
アクション ID |
performed_by_name
|
notifications.performed_by_name | string |
名前で実行 |
signing_order
|
notifications.signing_order | integer |
署名順序 |
ip_address
|
notifications.ip_address | string |
IP アドレス |
定義
file
これは基本的なデータ型 'ファイル' です。