Zoho Sign
Zohoのサインは、完全なセキュリティと信頼性でビジネスドキュメントにデジタル署名するのに役立つ完全なデジタル署名アプリです
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | Zoho Sign API のサポート |
| URL | https://www.zoho.com/sign/contact.html |
| support@zohosign.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Zoho Corporation |
| Website | https://www.zoho.com/sign/ |
| プライバシー ポリシー | https://www.zoho.com/privacy.html |
| カテゴリ | コンテンツとファイル。生産性 |
Zohoの電子署名ソフトウェアを使用して、完全なセキュリティと信頼性でビジネスドキュメントをオンラインでデジタル署名します。 シンプルな電子署名ドキュメント ワークフローを使用してトランザクションを自動化します。 ビジネス署名者向けの完全なデジタル署名アプリ。
[前提条件]
このコネクタを使用するには、Zoho-Sign プラットフォームの Zoho-Sign アカウントに対して支払いを行う必要があります。 詳細については、「 https://www.zoho.com/sign/pricing-api.htmlhttps://zoho.com/sign ##How でアカウントを設定して資格情報を取得することもできます。Zoho-Sign API は OAuth 2 を使用して認証します。 そのため、アカウントがセットアップされたら、追加の手順は必要ありません。
すべての Zoho Sign API には、次の必須ヘッダーが必要です: Authorization - Authentication request ヘッダー。
トークンの生成については、以下を参照してください。 https://www.zoho.com/sign/api/#getting-started
コネクタの概要
Zoho Sign Connector には、ユーザーが Zoho Sign の Web インターフェイスにアクセスすることなく、ドキュメント管理、テンプレート管理、およびその他の操作を直接実行するためのオプションが用意されています
ドキュメント マネージャーでは、これらのコネクタを使用して、ユーザーはドキュメントの作成、ドキュメントの更新、署名用のドキュメントの送信、アカウントに関連するすべてのドキュメントの一覧の取得を行うことができます。
同様に、他の操作については、次のリンクの「サポートされている操作とは」のタイトルを参照してください。
https://www.zoho.com/sign/api/#introduction
これらのコネクタは、ドキュメントやテンプレートからステータス追跡などへの送信から、使用状況の自動化に役立ちます。
一般的なエラーと解決方法
エラーが発生した場合は、適切なエラー コードとその理由を使用してデバッグします。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| リージョンを選択します。 | 文字列 | ドメインを選択します。 | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| API の呼び出し |
API の呼び出し |
|
Send |
アップロードしたドキュメントを署名用に送信する |
| テンプレートの一覧を取得する |
作成されたすべてのドキュメント テンプレートの一覧を表示します |
| ドキュメントのダウンロード |
特定の封筒をダウンロードする |
| ドキュメントの削除 |
特定のドキュメントを削除する |
| ドキュメントを取得する |
特定の封筒の詳細を表示します |
| ファイルのダウンロード |
特定のドキュメントまたはファイルをダウンロードする |
| 作成された要求のプロパティを更新する |
作成された要求のプロパティを更新する |
| 受信者のリマインダー |
特定のドキュメントの受信者にリマインダーを送信します。 |
| 完了した要求のデータを取得する |
署名された封筒の詳細を表示します |
| 完了証明書のダウンロード |
特定の封筒の完了証明書をダウンロードします |
| 特定のテンプレートの詳細を取得する |
特定のドキュメント テンプレートの詳細を表示します |
| 特定のドキュメントを取り消す |
特定のドキュメントを取り消す |
| 署名用のドキュメントを作成する |
ファイルをアップロードして署名用のドキュメントを作成するアクション。 |
API の呼び出し
API の呼び出し
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
URL パス
|
url | True | string |
URL パスを指定する |
|
メソッド
|
method | True | string |
使用する API メソッドの選択 |
戻り値
- response
- object
SendSignRequest
アップロードしたドキュメントを署名用に送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
RequestId | True | string |
リクエストID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | integer |
コード |
|
メッセージ
|
message | string |
メッセージ |
|
状態
|
status | string |
状態 |
テンプレートの一覧を取得する
作成されたすべてのドキュメント テンプレートの一覧を表示します
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
template_id
|
templates.template_id | string | |
|
template_name
|
templates.template_name | string |
テンプレート名 |
ドキュメントのダウンロード
ドキュメントの削除
特定のドキュメントを削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
request_id | True | integer |
リクエストID |
ドキュメントを取得する
特定の封筒の詳細を表示します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
RequestId | True | integer |
リクエストID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | integer |
コード |
|
request_status
|
requests.request_status | string |
要求の状態 |
|
注釈
|
requests.notes | string |
注記 |
|
attachments
|
requests.attachments | array of |
Attachments |
|
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 |
ドキュメント名 |
|
pages
|
requests.document_ids.pages | array of object |
pages |
|
image_string
|
requests.document_ids.pages.image_string | string |
イメージ文字列 |
|
page
|
requests.document_ids.pages.page | integer |
page |
|
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 |
ドキュメント 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 |
|
リクエスト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 |
ホストの使用状況の状態 |
|
言語
|
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
|
document_id | True | integer |
ドキュメント ID |
戻り値
- response
- 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 認証モードの受信者の電話番号の国コード。 |
|
|
アクションタイプ
|
action_type | string |
受信者が署名者か、閲覧者か承認者か、inpersonSigner かを選択します。 |
|
|
プライベート ノート
|
private_notes | string |
プライベート ノート |
|
|
署名順序
|
signing_order | integer |
署名順序 |
|
|
受信者の認証が必要
|
verify_recipient | boolean |
いずれかの認証モードで受信者を検証する必要があるかどうか。 |
|
|
認証配信の種類
|
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 | integer |
コード |
|
メッセージ
|
message | string |
メッセージ |
|
状態
|
status | string |
状態 |
受信者のリマインダー
特定のドキュメントの受信者にリマインダーを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
request_id | True | integer |
リクエストID |
完了した要求のデータを取得する
署名された封筒の詳細を表示します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
request_id | True | integer |
要求 ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | integer |
コード |
|
request_name
|
document_form_data.request_name | string |
要求名 |
|
zsdocumentid
|
document_form_data.zsdocumentid | string |
Zoho Sign Documentid |
|
アクション
|
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 |
受信者名 |
|
fields
|
document_form_data.actions.fields | array of object |
fields |
|
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 |
状態 |
完了証明書のダウンロード
特定の封筒の完了証明書をダウンロードします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
request_id | True | integer |
リクエストID |
戻り値
- response
- file
特定のテンプレートの詳細を取得する
特定のドキュメント テンプレートの詳細を表示します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレートの一覧
|
template_id | True | string |
テンプレートの一覧 |
特定のドキュメントを取り消す
特定のドキュメントを取り消す
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
request_id | True | integer |
リクエストID |
署名用のドキュメントを作成する
ファイルをアップロードして署名用のドキュメントを作成するアクション。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメントを作成する
|
file | True | file |
ドキュメントを作成する |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | integer |
コード |
|
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 |
ドキュメント名 |
|
pages
|
requests.document_ids.pages | array of object |
pages |
|
image_string
|
requests.document_ids.pages.image_string | string |
イメージ文字列 |
|
page
|
requests.document_ids.pages.page | integer |
page |
|
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 |
owner id |
|
説明
|
requests.description | string |
Description |
|
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 |
|
リクエスト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 |
owner 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 |
辞退理由 |
|
リクエスト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 |
Activity |
|
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' です。
オブジェクト
これは型 'object' です。