介绍
API根端点
//sign.hqwacp.icu/api/v1
API代表应用程序编程接口。 API是一组功能和过程，帮助用户直接从另一个应用程序访问应用程序，服务或操作系统的功能或数据。让'看看一个简单的例子来理解它更好。
当你’重新预订电影或飞行机票，您通常会在预订网站上查看您的Google日历选项。当您按此按钮时，预订网站将与谷歌交谈’S服务器直接在背景中使用请求创建事件计划。预订网站’S服务器将处理响应并在屏幕上显示确认消息。换句话说，你’使用应用程序的功能而无需访问其接口。
Zoho Sign API为用户提供了直接执行用户管理，文档管理和其他操作的选项，而无需访问Zoho标志’S Web界面。我们提供代表状态转移应用程序编程接口（REST API）以提供此目的。
为什么休息？
休息API.’S架构利用已经到位的协议。例如，它使用HTTP协议for Web API，这意味着在构建自定义应用程序时，开发人员可以为开发人员提供高度灵活性。它最初由罗伊博士于2000年开发，由全球开发商通过了易用性和简单性。
每个资源都被暴露为URL，可以通过访问API根端点来获取。
你的API有多安全？
Zoho Sign Rest API利用行业标准的OAuth 2.0协议进行授权。他们授权申请与他们互动，而无需赠送密码。换句话说，它们提供了委派服务和授权第三方应用程序以安全地访问用户帐户。
有什么支持的业务？
Zoho标志API支持下面提到的日益增长的操作列表。在接下来的几个月里，我们将支持我们的Web界面中提供的所有操作。
| 用户管理 |
|
| 文档管理 |
|
| 模板管理 |
|
| Webhook管理 |
|
先决条件
所有Zoho标志API都需要此强制标题。 授权 - 身份验证请求标头。
入门
例子
$ curl //sign.hqwacp.icu/api/v1/accounts \ -H 'Authorization: Zoho-oauthtoken <Oauth Token>'
- 注册一个新客户
- 生成拨款令牌
- 生成访问和刷新令牌
- 从刷新令牌生成访问令牌
- 撤消刷新令牌
- 致电API.
第1步：注册新客户
首先，您需要使用Zoho注册您的应用程序’S开发人员控制台获取您的客户ID和客户机密。
- 登录到 //accounts.hqwacp.icu/developerconsole
- 单击“添加客户端ID”
- 提供详细信息并注册您的申请
成功验证后，您将提供客户ID和客户机密。不要与任何人共享客户ID和客户机密
第2步：生成授权令牌
- 使用给定参数转到以下授权URL
//accounts.hqwacp.icu/oauth/v2/auth? - 在此请求上，您将被带到用户同意页面。
- 单击“接受”（单击拒绝将抛出错误）
Zoho将使用代码和状态参数重定向到给定的redirect_uri。该代码值是必需的，以在下一步中获取访问令牌，并且有效期为60秒。
请求示例
//accounts.hqwacp.icu/oauth/v2/auth?scope=zohosign.documents.create，zohosign.documents.read，zohosign.documents.update,ZohoSign.documents.DELETE&client_id=[Client ID]&state=testing&response_type=代码&redirect_uri=[Redirect URL]&access_type=offline
争论
|
scope
必需的
要生成令牌的范围。可以给出多个范围，其必须用逗号分隔。前任 ：
ZohoSign.documents.all
client_id
必需的
客户注册期间获得的客户端ID
state
必需的
在协议中循环的不透明字符串;即。，无论对此的任何值都将被传给您。
response_type
必需的
代码
redirect_uri
必需的
上面给出的重定向URI之一。此Param应该在注册客户端时提到的相同重定向URL
access_type
必需的
The allowed values are
offline and online
prompt
必需的
每次应用程序尝试访问用户凭据时，请提示用户同意。前任：
Consent |
第3步：生成访问和刷新令牌
在上面的步骤中生成代码后，使用给定参数为下面的URL进行后台请求，以生成access_token。
//accounts.hqwacp.icu/oauth/v2/token?- 在响应中，您将获得Access_Token和Refresh_Token。
- Access_Token将在特定时段（如expires_in param中配置）之后过期。
- Refresh_Token是永久性的，如果当前访问令牌已过期，则将用于重新生成新的Access_Token。
- 每次接受重新同意页面时，都会生成一个新的刷新令牌。每个用户的最大限制为20个刷新令牌。如果达到此限制，将自动删除第一个刷新令牌以适应最新的令牌。无论第一次刷新令牌是否正在使用，都是如此完成的。
请求示例
//accounts.hqwacp.icu/oauth/v2/token?code=[Code]&client_id=[Client ID]&client_secret=[Client Secret]&redirect_uri=[Redirect URL]&grant_type=authorization_code
争论
|
code
必需的
代码 在上述步骤中获得
client_id
必需的
客户注册期间获得的客户端ID
client_secret
必需的
客户注册期间获得的客户机密
redirect_uri
必需的
此PARAM应该在添加客户端时提到的相同重定向URL
grant_type
必需的
authorization_code
scope
必需的
要生成令牌的范围。可以给出多个范围，其必须用逗号分隔。前任 ：
ZohoSign.documents.all
state
必需的
在协议中循环的不透明字符串;也就是说，价值将被传给你。
|
步骤4：从刷新令牌生成访问令牌
访问令牌有有限的有效性。在大多数情况下，访问令牌将在一小时内到期。在此之前，访问令牌具有无限制的用法。一旦它到期，您的应用程序应使用刷新令牌来请求新的访问令牌。使用给定参数重定向到以下帖子URL以获取新的访问令牌。
//accounts.hqwacp.icu/oauth/v2/token?
请求示例
//accounts.hqwacp.icu/oauth/v2/token?refresh_token=[Refresh Token]&client_id=[Client Id]&client_secret=[Client Secret]&redirect_uri=[Redirect URL]&grant_type=refresh_token.
争论
|
refresh_token
必需的
在上面的步骤中获得的刷新令牌
client_id
必需的
客户注册期间获得的客户端ID
client_secret
必需的
客户注册期间获得的客户机密
redirect_uri
必需的
此PARAM应该在添加客户端时提到的相同重定向URL
grant_type
必需的
refresh_token. |
第5步：撤消刷新令牌
要撤消刷新令牌，请使用给定的参数调用以下帖子URL
//accounts.hqwacp.icu/oauth/v2/token/revoke?
请求示例
//accounts.hqwacp.icu/oauth/v2/token/revoke?refresh_token=[Refresh Token]
争论
|
refresh_token
必需的
在上面的步骤中获得的刷新令牌
|
第6步：调用API
访问令牌只能在标题中传递，无法在请求参数中传递。
标题名称应该是 Authorization
标题值应该是 Zoho-oauthtoken {access_token}
一些技巧
Zoho标志API为每个动作使用适当的HTTP动词。
| 方法 | 描述 |
|---|---|
| 得到 | 用于检索资源 |
| 邮政 | 用于创建资源并执行资源操作 |
| 放 | 用于更新资源 |
| 删除 | 用于删除资源 |
Zoho Sign使用HTTP状态码来指示API调用的状态。一般来说，
- 2xx范围内的状态代码意味着成功
- 4xx范围意味着提供的信息中存在错误
- 5xx范围中的那些表示服务器端错误。
| 状态码 | 描述 |
|---|---|
| 200 | 好的 |
| 400 | 错误的请求 |
| 401 | 未经授权的访问或无效的Auth令牌 |
| 404 | URL找不到 |
| 405 | Invoked API不支持不允许的方法或您所调用的方法 |
| 500 | 内部错误 |
Zoho标志API API检索文档，模板，用户和其他资源 - 默认检测到100项。分页信息将包含在节点名称Page_context下的列表API响应中。 默认情况下，将列出第一页。要通过页面导航，请使用start_index参数。 Row_Count参数可用于设置要在响应中接收的记录数。
用户管理
可以邀请用户成为您组织的一部分’s Zoho Sign account'作为管理员，您可以控制自己的访问权限。
OAuthscopes.
zohosign.account.create，zohosign.account.read，zohosign.account.update
检索用户帐户详细信息
得到 //sign.hqwacp.icu/api/v1/accounts
获取您帐户的详细信息。
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "User list retrieved successfully", "page_context.": { "sort_column.": "角色", "has_more_rows": false, "start_index.": 1, "排序": "ASC", "row_count.": 0 }, "users": [ { "user_email": "s********@***.com", "is_payment_owner": true, "角色": "Admin", "user_id": "2000000002002", "user_name": "S********", "is_allowed": true }, { "user_email": "v*********@***.com", "角色": "User", "user_id": "2000000006077", "user_name": "V********", "is_allowed": true }, ], "status": "success" }
邀请用户
这将邀请用户加入您的帐户。
邮政 //sign.hqwacp.icu/api/v1/users/invite请求示例
$ curl //sign.hqwacp.icu/api/v1/users/invite \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'email_id=["v********@****"]'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "invitations": [ { "user_email": "v*******@*****", "is_invited": true } ], "message": "Invitation has been sent", "status": "success" }
争论
|
email_id
大批
电子邮件列表
|
检索用户列表
这将检索属于帐户的一部分的用户列表。
得到 //sign.hqwacp.icu/api/v1/users请求示例
$ curl //sign.hqwacp.icu/api/v1/users \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "User list retrieved successfully", "page_context.": { "sort_column.": "角色", "has_more_rows": false, "start_index.": 1, "排序": "ASC", "row_count.": 0 }, "users": [ { "user_email": "s********@***.com", "is_payment_owner": true, "角色": "Admin", "user_id": "2000000002002", "user_name": "S********", "is_allowed": true }, { "user_email": "V******@***.com", "角色": "User", "user_id": "2000000006077", "user_name": "V********", "is_allowed": true }, ], "status": "success" }
更新用户访问
放 //sign.hqwacp.icu/api/v1/users/[User Id]
这将帮助您授予或撤消用户访问权限。
请求示例
$ curl //sign.hqwacp.icu/api/v1/users/[User Id] \ -X PUT \ -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'allowed_access=true'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 {"代码":0,"message":"Access has been changed for the selected user","status":"success"}
争论
|
allowed_access
布尔基
允许访问用户[true / false]。
|
更新用户角色
放 //sign.hqwacp.icu/api/v1/users/[User Id]
这将帮助您修改用户在帐户中的角色。
请求示例
$ curl //sign.hqwacp.icu/api/v1/users/[User Id] \ -X PUT \ -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'role=User'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 {"代码":0,"message":"Role has been changed for the selected user","status":"success"}
争论
|
role
细绳
用户[用户/ admin]的角色。
|
删除用户
放 //sign.hqwacp.icu/api/v1/users/[User Id]/delete
这将帮助您从帐户中删除用户。
请求示例
$ curl //sign.hqwacp.icu/api/v1/users/[User Id]/delete \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 {"代码":0,"message":"User has been deleted","status":"success"}
文档管理
创建文档，更新文档，向签名发送文档并获取与您帐户相关的所有文档的列表。
OAuthscopes.
zohosign.documents.create，zohosign.documents.read，zohosign.documents.update
创建和发送文档涉及以下步骤：
- 创建文件
- 获取现场类型
- 添加字段并发送文档以获取签名
创建文件
邮政 //sign.hqwacp.icu/api/v1/requests
这将创建一个新文档。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -F '[email protected] to file' \ -F 'data={ "要求": { "Request_type_id.": "2000000322040", "Request_name.": "NDA ", "行动": [ { "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "recipient_phonenumber": "", "recipient_countrycode": "", "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "signing_order.": 0, "验证_recipient.": true, "验证_type.": "EMAIL", "验证码": "" } ], "expiration_days.": 1, "is_equential.": true, "Email_Reminders.": true, "提醒_Period.": 8, "folder_id.": "2000000489161" } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": { "Request_status.": "draft", "owner_email": "v*******@***.com", "created_time": 1522739606981, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "document_name": "4page170kbsquared file testrotated.pdf", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 174307, "document_order": "0", "total_pages": 4, "document_id.": "2000000489185" } ], "笔记": "", "self_sign": false, "owner_id": "2000000002002", "description": "", "文件夹名称": "NDA", "Request_name.": "NDA ", "modified_time": 1522739606981, "is_deleted": false, "expiration_days.": 1, "in_process": false, "is_equential.": true, "Request_type_name.": "NDA document", "owner_first_name": "V******", "folder_id.": "2000000489161", "request_id": "2000000489191", "Request_type_id.": "2000000322040", "owner_last_name": "", "行动": [ { "验证_recipient.": true, "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "验证_type.": "EMAIL", "allow_signing": true, "recipient_phonenumber": "", "action_id.": "2000000489194", "signing_order.": 0, "领域": [], "action_status": "NOACTION", "recipient_countrycode": "" } ], "sign_percentage": 0 }, "message": "Document has been added", "status": "success" }
争论
|
file
文件
需要上传的文件
|
更新文档
放 //sign.hqwacp.icu/api/v1/requests/[Request Id]
这将帮助您更新现有文档。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request Id] \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'data={ "要求": { "行动": [ { "验证_recipient.": true, "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "验证_type.": "EMAIL", "recipient_phonenumber": "", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "action_id.": "2000000489194", "signing_order.": 0, "领域": { "text_fields": [ { "document_id.": "2000000489185", "field_name.": "Company", "abs_width.": 16, "abs_height.": 5, "X_COORD.": 9, "Y_COORD.": 6, "Page_no.": 0, "是强制性的": true, "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false }, "field_type_name.": "Company" }, { "document_id.": "2000000489185", "field_name.": "Full name", "abs_width.": 16, "abs_height.": 5, "X_COORD.": 50, "Y_COORD.": 6, "Page_no.": 0, "是强制性的": true, "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false }, "name_format.": "FULL_NAME", "field_type_name.": "Name" }, { "document_id.": "2000000489185", "field_name.": "Email", "abs_width.": 31, "abs_height.": 5, "X_COORD.": 22, "Y_COORD.": 11, "Page_no.": 0, "是强制性的": true, "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false }, "field_type_name.": "Email" } ], "image_fields": [ { "document_id.": "2000000489185", "field_name.": "Signature", "abs_width.": 22, "abs_height.": 5, "是强制性的": true, "X_COORD.": 6, "Y_COORD.": 0, "Page_no.": 0, "field_type_name.": "Signature" }, { "document_id.": "2000000489185", "field_name.": "Initial", "abs_width.": 8, "abs_height.": 5, "是强制性的": true, "X_COORD.": 50, "Y_COORD.": 0, "Page_no.": 0, "field_type_name.": "Initial" } ], "date_fields": [ { "document_id.": "2000000489185", "field_name.": "Sign Date", "abs_width.": 16, "abs_height.": 1, "X_COORD.": 62, "Y_COORD.": 11, "Page_no.": 0, "是强制性的": true, "日期格式": "MMM dd yyyy", "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false }, "field_type_name.": "Date" } ], "check_boxes": [ { "document_id.": "2000000489185", "field_name.": "Checkbox_1", "abs_width.": 12, "abs_height.": 5, "是强制性的": false, "默认值": false, "X_COORD.": 9, "Y_COORD.": 10, "Page_no.": 0, "is_read_only": false, "Field_Label.": "Checkbox_1", "field_type_name.": "Checkbox" } ], "radio_groups": [] }, "recipient_countrycode": "", "deleted_fields": [] }, ], "deleted_actions": [], "Request_name.": "NDA " } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": { "Request_status.": "draft", "笔记": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?", "owner_id": "2000000002002", "description": "", "Request_name.": "Leave a note test", "modified_time": 1522745916988, "action_time": 1522745917015, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "sign_submitted_time": 1522745917015, "owner_first_name": "V****", "sign_percentage": 33.34, "expire_by": 1522866540000, "is_expiring": true, "owner_email": "v*******@***.com", "created_time": 1522745900919, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "document_name": "Employee NDA.pdf", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 27059, "document_order": "0", "total_pages": 2, "document_id.": "2000000493003" } ], "self_sign": false, "in_process": false, "Request_type_name.": "Others", "request_id": "2000000493009", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": false, "action_id.": "2000000493012", "action_type.": "SIGN", "private_notes.": "", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "signing_order.": 0, "领域": [ { "field_id.": "2000000493016", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Signature", "Y_COORD.": 5, "action_id.": "2000000493012", "abs_width.": 22, "field_type_name.": "Signature", "description_tooltip.": "", "X_COORD.": 42, "abs_height.": 2 }, { "field_id.": "2000000493017", "field_category": "image", "Field_Label.": "Initial", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Initial", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 18, "field_type_name.": "Initial", "description_tooltip.": "", "X_COORD.": 71, "abs_height.": 5 }, { "field_id.": "2000000493015", "text_property.": { "is_initic": false, "is_underline": false, "字体颜色": "000000", "字体大小": 11, "is_read_only": false, "is_bold.": false, "字体": "Arial" }, "field_category": "textfield", "Field_Label.": "Email", "是强制性的": true, "默认值": "", "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Email", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 30, "field_type_name.": "Email", "description_tooltip.": "", "X_COORD.": 4 "abs_height.": 5 }, { "field_id.": "2000000493014", "field_category": "checkbox", "Field_Label.": "Checkbox_1", "是强制性的": false, "默认值": false, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Checkbox_1", "Y_COORD.": 10, "action_id.": "2000000493012", "abs_width.": 10, "is_read_only": false, "field_type_name.": "Checkbox", "description_tooltip.": "", "X_COORD.": 80, "abs_height.": 10 } ], "allow_signing": true, "action_status": "UNOPENED", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "status": "success" }
争论
发送签名文档
邮政 //sign.hqwacp.icu/api/v1/requests/[Request Id]/submit
这将帮助您向收件人发送文档以获取签名。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request Id]/submit \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -d 'data={ "要求": { "行动": [ { "验证_recipient.": false, "action_id.": "2000000493012", "action_type.": "SIGN", "private_notes.": "", "signing_order.": 0, "领域": [ { "field_id.": "2000000493015", "field_type_name.": "Email", "text_property.": { "is_initic": false, "is_underline": false, "字体颜色": "000000", "字体大小": 11, "is_read_only": false, "is_bold.": false, "字体": "Arial" }, "field_category": "textfield", "Field_Label.": "Email", "是强制性的": true, "默认值": "", "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Email", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 30, "description_tooltip.": "", "X_COORD.": 4, "abs_height.": 2 }, { "field_id.": "2000000493016", "field_type_name.": "Signature", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Signature", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 22, "description_tooltip.": "", "X_COORD.": 42, "abs_height.": 2 }, { "field_id.": "2000000493017", "field_type_name.": "Initial", "field_category": "image", "Field_Label.": "Initial", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Initial", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 18, "description_tooltip.": "", "X_COORD.": 71, "abs_height.": 5 }, { "field_id.": "2000000493014", "field_type_name.": "Checkbox", "field_category": "checkbox", "Field_Label.": "Checkbox_1", "是强制性的": false, "默认值": false, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Checkbox_1", "Y_COORD.": 10, "action_id.": "2000000493012", "abs_width.": 18, "is_read_only": false, "description_tooltip.": "", "X_COORD.": 80, "abs_height.": 5 } ], "recipient_phonenumber": "", "recipient_countrycode": "", "deleted_fields": [] } ], "deleted_actions": [], "Request_name.": "Leave a note test" } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": { "Request_status.": "inprogress", "笔记": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?", "owner_id": "2000000002002", "description": "", "Request_name.": "Leave a note test", "modified_time": 1522745916988, "action_time": 1522745917015, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "sign_submitted_time": 1522745917015, "owner_first_name": "V****", "sign_percentage": 33.34, "expire_by": 1522866540000, "is_expiring": true, "owner_email": "v********@***.com", "created_time": 1522745900919, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "document_name": "Employee NDA.pdf", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 27059, "document_order": "0", "total_pages": 2, "document_id.": "2000000493003" } ], "self_sign": false, "in_process": false, "Request_type_name.": "Others", "request_id": "2000000493009", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": false, "action_id.": "2000000493012", "action_type.": "SIGN", "private_notes.": "", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "signing_order.": 0, "领域": [ { "field_id.": "2000000493016", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Signature", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 22, "field_type_name.": "Signature", "description_tooltip.": "", "X_COORD.": 42, "abs_height.": 5 }, { "field_id.": "2000000493017", "field_category": "image", "Field_Label.": "Initial", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Initial", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 18, "field_type_name.": "Initial", "description_tooltip.": "", "X_COORD.": 71, "abs_height.": 5 }, { "field_id.": "2000000493015", "text_property.": { "is_initic": false, "is_underline": false, "字体颜色": "000000", "字体大小": 11, "is_read_only": false, "is_bold.": false, "字体": "Arial" }, "field_category": "textfield", "Field_Label.": "Email", "是强制性的": true, "默认值": "", "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Email", "Y_COORD.": 3, "action_id.": "2000000493012", "abs_width.": 30, "field_type_name.": "Email", "description_tooltip.": "", "X_COORD.": 4, "abs_height.": 5 }, { "field_id.": "2000000493014", "field_category": "checkbox", "Field_Label.": "Checkbox_1", "是强制性的": false, "默认值": false, "Page_no.": 0, "document_id.": "2000000493003", "field_name.": "Checkbox_1", "Y_COORD.": 10, "action_id.": "2000000493012", "abs_width.": 18, "is_read_only": false, "field_type_name.": "Checkbox", "description_tooltip.": "", "X_COORD.": 80, "abs_height.": 5 } ], "allow_signing": true, "action_status": "UNOPENED", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "status": "success" }
争论
获取特定文件的详细信息
得到 //sign.hqwacp.icu/api/v1/requests/[Request Id]
获取特定文档的详细信息，该文件介绍文档的详细信息，包括文档的状态。使用钥匙“request_status”检查文档完成
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request Id] \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": { "Request_status.": "inprogress", "笔记": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?", "owner_id": "2000000002002", "description": "", "Request_name.": "Leave a note test", "modified_time": 1522746018025, "action_time": 1522746018310, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "sign_submitted_time": 1522746018310, "owner_first_name": "V********", "sign_percentage": 33.34, "expire_by": 1522866540000, "is_expiring": true, "owner_email": "v******@***.com", "created_time": 1522746018025, "document_id.s": [ { "document_name": "Employee NDA.pdf", "document_size": 26591, "document_order": "0", "total_pages": 2, "document_id.": "2000000492171" } ], "self_sign": false, "in_process": false, "Request_type_name.": "Others", "request_id": "2000000492177", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": false, "action_id.": "2000000492180", "action_type.": "SIGN", "private_notes.": "", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "signing_order.": 0, "allow_signing": true, "action_status": "UNOPENED", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "message": "Document has been retrieved", "status": "success" }
获取文件列表
得到 //sign.hqwacp.icu/api/v1/requests
这将帮助您获取帐户中的文档列表。
请求示例
$ curl -G //sign.hqwacp.icu/api/v1/requests \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ --data-urlencode 'data={"page_context.":{"row_count.":10,"start_index.":1,"search_columns":{},"sort_column.":"created_time","排序":"DESC"}}'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": [ { "Request_status.": "inprogress", "笔记": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?", "owner_id": "2000000002002", "description": "", "Request_name.": "Leave a note test", "modified_time": 1522746018025, "action_time": 1522746018310, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "sign_submitted_time": 1522746018310, "owner_first_name": "V********", "sign_percentage": 33.34, "expire_by": 1522866540000, "is_expiring": true, "owner_email": "v******@***.com", "created_time": 1522746018025, "document_id.s": [ { "document_name": "Employee NDA.pdf", "document_size": 26591, "document_order": "0", "total_pages": 2, "document_id.": "2000000492171" } ], "self_sign": false, "in_process": false, "Request_type_name.": "Others", "request_id": "2000000492177", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": false, "action_id.": "2000000492180", "action_type.": "SIGN", "private_notes.": "", "收件人姓名": "S**********", "收件人电子邮件": "s*******@***.com", "signing_order.": 0, "allow_signing": true, "action_status": "UNOPENED", "recipient_phonenumber": "", "recipient_countrycode": "" } ] } ], "message": "Document list retrieved successfully", "page_context.": { "sort_column.": "created_time", "has_more_rows": true, "start_index.": 1, "total_count": 1, "排序": "DESC", "row_count.": 10 }, "status": "success" }
争论
下载PDF.
得到 //sign.hqwacp.icu/api/v1/requests/[Request ID]/pdf
检索可以下载的PDF内容。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/pdf \ -X GET \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/pdf; OR Content-Type:application/zip; (In case of multiple documents)
下载特定的PDF文件
得到 //sign.hqwacp.icu/api/v1/requests/[Request Id]/documents/[Document Id]/pdf
检索特定文件的PDF内容。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request Id]/documents/[Document Id]/pdf \ -X GET \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/pdf;
下载完成证书
得到 //sign.hqwacp.icu/api/v1/requests/[Request ID]/completioncertificate
检索完成证书PDF内容。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/completioncertificate \ -X GET \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/pdf;
获取文档表单数据
得到 //sign.hqwacp.icu/api/v1/requests/[Request ID]/fielddata
检索特定文档的填充字段数据。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/fielddata \ -X GET \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "document_form_data": { "Request_name.": "Student Details.pdf", "zsdocumentid": "CWME3N7DBV6-QIGQ_LENFZVZEWSSO1SBXZBGTUR96EI", "行动": [ { "signed_time": "May 21 2019 14:01 IST", "action_type.": "SIGN", "收件人电子邮件": "va******@******.com", "收件人姓名": "Va******", "领域": [ { "Field_Label.": "Checkbox - 2", "field_value.": "false" }, { "Field_Label.": "Checkbox - 1", "field_value.": "false" }, { "Field_Label.": "Last name", "field_value.": "******" }, { "Field_Label.": "Middle Name", "field_value.": "_" }, { "Field_Label.": "Email", "field_value.": "va******@******.com" }, { "Field_Label.": "Phone no.", "field_value.": "-" }, { "Field_Label.": "Comment", "field_value.": "******" }, { "Field_Label.": "Date - 1", "field_value.": "May 01 2019" }, { "Field_Label.": "Dropdown - 1", "field_value.": "******" } ] } ] }, "status": "success" }
召回文件
邮政 //sign.hqwacp.icu/api/v1/requests/[Request ID]/recall
调用文档取消签名流程。调用文档后，收件人无法再查看或签名。如果您发送不正确的文档，或者将其发送到错误的电子邮件地址，则可以调用文档。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/recall \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "action_time": 1546600722216, "message": "Document has been recalled", "status": "success" }
提醒收件人
邮政 //sign.hqwacp.icu/api/v1/requests/[Request ID]/remind
提醒发送给需要签名的人。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/remind \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Reminder has been sent", "status": "success" }
删除文档
放 //sign.hqwacp.icu/api/v1/requests/[Request ID]/delete
删除文档将其移至垃圾。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Request ID]/delete \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Document deleted successfully", "status": "success" }
创建新文件夹
邮政 //sign.hqwacp.icu/api/v1/folders
这将帮助您创建一个新文件夹。
请求示例
$ curl //sign.hqwacp.icu/api/v1/folders \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -d 'data={ "文件夹": { "文件夹名称": "Quote Folder" } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "文件夹": { "文件夹名称": "Quote Folder", "folder_id.": "2000000495005" }, "message": "文件夹 added successfully", "status": "success" }
争论
获取文件夹列表
得到 //sign.hqwacp.icu/api/v1/folders
这将获取帐户中的文件夹列表。
请求示例
$ curl //sign.hqwacp.icu/api/v1/folders \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "文件夹": [ { "文件夹名称": "Quote Folder", "folder_id.": "2000000495005" }, { "文件夹名称": "NDA", "folder_id.": "2000000489161" } ], "message": "文件夹(s) retrieved successfully", "status": "success" }
检索字段类型
得到 //sign.hqwacp.icu/api/v1/fieldtypes
这将帮助您检索字段类型。
请求示例
$ curl //sign.hqwacp.icu/api/v1/fieldtypes \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "field_types": [ { "field_type_id": "2000000000137", "field_category": "checkbox", "是强制性的": false, "field_type_name.": "Checkbox" }, { "field_type_id": "2000000000139", "field_category": "radiogroup", "是强制性的": false, "field_type_name.": "Radiogroup" }, { "field_type_id": "2000000000141", "field_category": "image", "是强制性的": true, "field_type_name.": "Signature" }, { "field_type_id": "2000000000143", "field_category": "image", "是强制性的": true, "field_type_name.": "Initial" }, { "field_type_id": "2000000000147", "field_category": "textfield", "是强制性的": false, "field_type_name.": "Textfield" }, { "field_type_id": "2000000000149", "field_category": "textfield", "是强制性的": true, "field_type_name.": "Email" }, { "field_type_id": "2000000000151", "field_category": "datefield", "是强制性的": true, "field_type_name.": "Date" }, { "field_type_id": "2000000000153", "field_category": "textfield", "是强制性的": true, "field_type_name.": "Name" }, { "field_type_id": "2000000000155", "field_category": "textfield", "是强制性的": true, "field_type_name.": "Company" }, { "field_type_id": "2000000000157", "field_category": "textfield", "是强制性的": true, "field_type_name.": "Jobtitle" } ], "代码": 0, "message": "Field types retrieved successfully", "status": "success" }
获取文档类型
得到 //sign.hqwacp.icu/api/v1/requesttypes
这将有助于您找到文档类型。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requesttypes \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Document types retrieved successfully", "请求类型s": [ { "Request_type_description.": "Others", "Request_type_name.": "Others", "Request_type_id.": "2000000000135" }, { "Request_type_description.": "", "Request_type_name.": "NDA document", "Request_type_id.": "2000000322040" } ], "status": "success" }
创建新文档类型
邮政 //sign.hqwacp.icu/api/v1/requesttypes
这将帮助您创建新的文档类型。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requesttypes \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -d 'data={ "请求类型s": { "Request_type_name.": "Quote", "Request_type_description.": "" } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Document type added successfully", "请求类型s": [ { "Request_type_description.": "", "Request_type_name.": "Quote", "Request_type_id.": "2000000495001" } ], "status": "success" }
争论
更新文档类型
邮政 //sign.hqwacp.icu/api/v1/requesttypes/[RequestTypeId]
这将帮助您更新现有文档类型。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requesttypes/2000000495001 \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -X PUT \ -d 'data={ "请求类型s": { "Request_type_name.": "Quote1", "Request_type_description.": "" } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Document type updated successfully", "请求类型s": [ { "Request_type_description.": "", "Request_type_name.": "Quote1", "Request_type_id.": "2000000495001" } ], "status": "success" }
争论
模板管理
根据您的需求在Zoho标志中创建可自定义模板。模板可以使用任何次数。
OAuthscopes.
zohosign.templates.Create，zohosign.templates.read，zohosign.templates.update
创建模板
邮政 //sign.hqwacp.icu/api/v1/templates
这将帮助您创建一个新模板。
请求示例
$ curl //sign.hqwacp.icu/api/v1/templates \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -F '[email protected] to file' \ -F 'data={ "模板": { "template_name.": "Template 1", "Request_type_id.": "2000000000135", "expiration_days.": 1, "is_equential.": true, "提醒_Period.": 8, "Email_Reminders.": false, "行动": [ { "action_type.": "SIGN", "signing_order.": 0, "收件人姓名": "", "角色": "1", "收件人电子邮件": "", "recipient_phonenumber": "", "recipient_countrycode": "", "private_notes.": "Please get back to us for further queries", "验证_recipient.": true, "验证_type.": "EMAIL", "验证码": "" } ] } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "模板": { "owner_email": "v****@***.com", "created_time": 1522746328987, "Email_Reminders.": false, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 174307, "document_order": "0", "total_pages": 4, "document_id.": "2000000493029" } ], "笔记": "", "提醒_Period.": 8, "owner_id": "2000000002002", "document_fields": [ { "document_id.": "2000000493029", "领域": [] } ], "description": "", "template_name.": "Template 1", "modified_time": 1522746328987, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "template_id": "2000000493035", "Request_type_name.": "Others", "owner_first_name": "V*******", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": true, "角色": "1", "action_id.": "2000000493038", "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "收件人电子邮件": "", "signing_order.": 0, "验证_type.": "EMAIL", "领域": [], "收件人姓名": "", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "message": "Template has been added ", "status": "success" }
争论
|
file
文件
需要上传的文件
data
jsonobject.
templates
jsonobject.
template_name
细绳
模板的名称
notes
细绳
表明模板
request_type_id
细绳
文档类别ID
notes
细绳
要发送给所有收件人的消息
expiration_days
㈡
在从模板转换时，文档将过期的日子
is_sequential
布尔基
顺序签名/并行签名[TRUE / FALSE]
email_reminders
布尔基
发送自动提醒
reminder_period
㈡
在[n]天中发送自动提醒一次
folder_id
细绳
文件夹
actions
杰森阵列
收件人列表
|
更新模板
放 //sign.hqwacp.icu/api/v1/templates/[Template Id]
这将帮助您更新现有模板。
请求示例
$ curl //sign.hqwacp.icu/api/v1/requests/[Template Id] \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'data={ "模板": { "document_fields": [ { "领域": { "image_fields": [ { "field_type_name.": "Signature", "field_name.": "Signature", "document_id.": "2000000493029", "是强制性的": true, "Page_no.": 0, "X_COORD.": 17, "Y_COORD.": 12, "abs_width.": 22, "abs_height.": 5 }, { "field_type_name.": "Initial", "field_name.": "Initial", "document_id.": "2000000493029", "是强制性的": true, "Page_no.": 0, "X_COORD.": 59, "Y_COORD.": 14, "abs_width.": 8, "abs_height.": 5 } ], "date_fields": [], "check_boxes": [], "radio_groups": [], "text_fields": [] }, "document_id.": "2000000493029", "deleted_fields": [] } ], "行动": [ { "action_id.": "2000000493038", "action_type.": "SIGN", "signing_order.": 0, "收件人姓名": "", "角色": "1", "收件人电子邮件": "", "recipient_phonenumber": "", "recipient_countrycode": "", "private_notes.": "Please get back to us for further queries", "验证_recipient.": true, "验证_type.": "EMAIL", "deleted_fields": [], "deleted_radio_fields": [], "领域": { "text_fields": [ { "field_type_name.": "Company", "field_name.": "Company", "document_id.": "2000000493029", "是强制性的": true, "Page_no.": 0, "X_COORD.": 31, "Y_COORD.": 1, "abs_width.": 16, "abs_height.": 5, "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false } }, { "field_type_name.": "Email", "field_name.": "Email", "document_id.": "2000000493029", "是强制性的": true, "Page_no.": 0, "X_COORD.": 56, "Y_COORD.": 1, "abs_width.": 31, "abs_height.": 5, "text_property.": { "字体": "Arial", "字体大小": 11, "字体颜色": "000000", "is_bold.": false, "is_initic": false } } ], "image_fields": [ { "field_type_name.": "Signature", "field_name.": "Signature", "document_id.": "2000000493029", "是强制性的": true, "Page_no.": 0, "X_COORD.": 2, "Y_COORD.": 1, "abs_width.": 22, "abs_height.": 5 } ], "date_fields": [], "check_boxes": [ { "field_type_name.": "Checkbox", "field_name.": "Checkbox_1", "document_id.": "2000000493029", "是强制性的": false, "Page_no.": 0, "X_COORD.": 50, "Y_COORD.": 1, "abs_width.": 20, "abs_height.": 5, "默认值": false } ], "radio_groups": [] } } ] } }'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "模板": { "owner_email": "v****@***.com", "created_time": 1522746328987, "Email_Reminders.": false, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "document_name": "4page170kbsquared file testrotated.pdf", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 174307, "document_order": "0", "total_pages": 4, "document_id.": "2000000493029" } ], "笔记": "", "提醒_Period.": 8, "owner_id": "2000000002002", "document_fields": [ { "document_id.": "2000000493029", "领域": [ { "field_id.": "2000000493047", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Signature", "Y_COORD.": 12, "abs_width.": 22, "field_type_name.": "Signature", "description_tooltip.": "", "X_COORD.": 17, "abs_height.": 5 }, { "field_id.": "2000000493048", "field_category": "image", "Field_Label.": "Initial", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Initial", "Y_COORD.": 14, "abs_width.": 18, "field_type_name.": "Initial", "description_tooltip.": "", "X_COORD.": 59, "abs_height.": 5 } ] } ], "description": "", "template_name.": "Template 1", "modified_time": 1522746467719, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "template_id": "2000000493035", "Request_type_name.": "Others", "owner_first_name": "V*******", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": true, "角色": "1", "action_id.": "2000000493038", "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "收件人电子邮件": "", "signing_order.": 0, "验证_type.": "EMAIL", "领域": [ { "field_id.": "2000000493043", "field_category": "checkbox", "Field_Label.": "Checkbox_1", "是强制性的": false, "默认值": false, "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Checkbox_1", "Y_COORD.": 1, "action_id.": "2000000493038", "abs_width.": 20, "is_read_only": false, "field_type_name.": "Checkbox", "description_tooltip.": "", "X_COORD.": 50, "abs_height.": 5 }, { "field_id.": "2000000493044", "text_property.": { "is_initic": false, "is_underline": false, "字体颜色": "000000", "字体大小": 11, "is_read_only": false, "is_bold.": false, "字体": "Arial" }, "field_category": "textfield", "Field_Label.": "Company", "是强制性的": true, "默认值": "", "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Company", "Y_COORD.": 1, "action_id.": "2000000493038", "abs_width.": 16, "field_type_name.": "Company", "description_tooltip.": "", "X_COORD.": 31, "abs_height.": 5 }, { "field_id.": "2000000493045", "text_property.": { "is_initic": false, "is_underline": false, "字体颜色": "000000", "字体大小": 11, "is_read_only": false, "is_bold.": false, "字体": "Arial" }, "field_category": "textfield", "Field_Label.": "Email", "是强制性的": true, "默认值": "", "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Email", "Y_COORD.": 1, "action_id.": "2000000493038", "abs_width.": 31, "field_type_name.": "Email", "description_tooltip.": "", "X_COORD.": 56, "abs_height.": 5 }, { "field_id.": "2000000493046", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000493029", "field_name.": "Signature", "Y_COORD.": 1, "action_id.": "2000000493038", "abs_width.": 22, "field_type_name.": "Signature", "description_tooltip.": "", "X_COORD.": 2, "abs_height.": 5 } ], "收件人姓名": "", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "status": "success" }
争论
|
data
jsonobject.
templates
jsonobject.
template_name
细绳
模板的名称
notes
细绳
表明模板
request_type_id
细绳
文档类别ID
notes
细绳
要发送给所有收件人的消息
expiration_days
㈡
在从模板转换时，文档将过期的日子
is_sequential
布尔基
顺序签名/并行签名[TRUE / FALSE]
email_reminders
布尔基
发送自动提醒
reminder_period
㈡
在[n]天中发送自动提醒一次
folder_id
细绳
文件夹
actions
杰森阵列
收件人列表
|
获取模板列表
得到 //sign.hqwacp.icu/api/v1/templates
这将有助于您在帐户中获取模板列表。
请求示例
$ curl -G //sign.hqwacp.icu/api/v1/templates \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ --data-urlencode 'data={"page_context.":{"row_count.":10,"start_index.":1,"search_columns":{},"sort_column.":"created_time","排序":"DESC"}}'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "模板": [ { "owner_email": "v******@***.com", "created_time": 1522746328987, "Email_Reminders.": false, "document_id.s": [ { "document_name": "4page170kbsquared file testrotated.pdf", "document_size": 174307, "document_order": "0", "total_pages": 4, "document_id.": "2000000493029" } ], "笔记": "", "提醒_Period.": 8, "owner_id": "2000000002002", "description": "", "template_name.": "Template 1", "modified_time": 1522747039504, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "template_id": "2000000493035", "Request_type_name.": "Others", "owner_first_name": "V*******", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": true, "角色": "1", "action_id.": "2000000493038", "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "收件人电子邮件": "", "signing_order.": 0, "验证_type.": "EMAIL", "收件人姓名": "", "recipient_phonenumber": "", "recipient_countrycode": "" } ] } ], "message": "Template list retrieved successfully", "page_context.": { "sort_column.": "created_time", "has_more_rows": true, "start_index.": 1, "total_count": 12, "排序": "DESC", "row_count.": 10 }, "status": "success" }
争论
获取模板详细信息
得到 //sign.hqwacp.icu/api/v1/templates[Template ID]
使用其ID获取特定模板的详细信息 - 特别列出需要发送的预填充字段，以便将模板转换为文档。
请求示例
$ curl //sign.hqwacp.icu/api/v1/templates/[Template ID] \ -X GET \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "模板": { "owner_email": "v******@***.com", "created_time": 1522746328987, "Email_Reminders.": false, "document_id.s": [ { "document_name": "4page170kbsquared file testrotated.pdf", "document_size": 174307, "document_order": "0", "total_pages": 4, "document_id.": "2000000493029" } ], "笔记": "", "提醒_Period.": 8, "owner_id": "2000000002002", "description": "", "template_name.": "Template 1", "modified_time": 1522747039504, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "template_id": "2000000493035", "Request_type_name.": "Others", "owner_first_name": "V*******", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": true, "角色": "1", "action_id.": "2000000493038", "action_type.": "SIGN", "private_notes.": "Please get back to us for further queries", "收件人电子邮件": "", "signing_order.": 0, "验证_type.": "EMAIL", "收件人姓名": "", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "message": "Template list retrieved successfully", "status": "success" }
使用模板发送签名文档
邮政 //sign.hqwacp.icu/api/v1/templates/[Template Id]/createdocument
为了使用模板，需要给予收件人详细信息。在以前的调用中，操作数组包含收件人的数量。它可能会或可能没有电子邮件地址。使用模板时，需要将操作与电子邮件ID和所有名称一起发送。无法更改操作次数。如果有要填充的文档字段（Document_Fields数组），则还需要填充那些人的值。如果是“is_mandatory”对于一个字段来说是真的，那么它必须具有值。否则不需要发送值。
请求示例
$ curl //sign.hqwacp.icu/api/v1/templates/[Template Id]/createdocument \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ -d 'data={ "模板": { "field_data.": { "field_text_data.": {}, "field_boolean_data.": {}, "field_date_data.": {}, }, "行动": [ { "action_id.": "2000000468052", "action_type.": "SIGN", "收件人姓名": "S********", "角色": "ts1", "收件人电子邮件": "s********@***.com", "recipient_phonenumber": "", "recipient_countrycode": "", "private_notes.": "", "验证_recipient.": true, "验证_type.": "EMAIL" } ], "笔记": "" } }&is_quicksend=true'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "要求": { "Request_status.": "inprogress", "笔记": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?", "owner_id": "2000000002002", "description": "", "Request_name.": "Leave a note test", "modified_time": 1522746018025, "action_time": 1522746018310, "is_deleted": false, "expiration_days.": 1, "is_equential.": true, "sign_submitted_time": 1522746018310, "owner_first_name": "V*******", "sign_percentage": 33.34, "expire_by": 1522866540000, "is_expiring": true, "owner_email": "v**********@***.com", "created_time": 1522746018025, "document_id.s": [ { "image_string": "<BASE 64 Image String>", "document_name": "Employee NDA.pdf", "pages": [ { "image_string": "<BASE 64 Image String>", "page": 0, "is_thumbnail": true } ], "document_size": 26591, "document_order": "0", "total_pages": 2, "document_id.": "2000000492171" } ], "self_sign": false, "in_process": false, "Request_type_name.": "Others", "request_id": "2000000492177", "Request_type_id.": "2000000000135", "owner_last_name": "", "行动": [ { "验证_recipient.": false, "action_id.": "2000000492180", "action_type.": "SIGN", "private_notes.": "", "收件人电子邮件": "s***********@***.com", "signing_order.": 0, "领域": [ { "field_id.": "2000000492182", "field_category": "image", "Field_Label.": "Signature", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000492171", "field_name.": "Signature", "Y_COORD.": 3, "action_id.": "2000000492180", "abs_width.": 22, "field_type_name.": "Signature", "description_tooltip.": "", "X_COORD.": 42, "abs_height.": 5 }, { "field_id.": "2000000492183", "field_category": "image", "Field_Label.": "Initial", "是强制性的": true, "Page_no.": 0, "document_id.": "2000000492171", "field_name.": "Initial", "Y_COORD.": 3, "action_id.": "2000000492180", "abs_width.": 18, "field_type_name.": "Initial", "description_tooltip.": "", "X_COORD.": 71, "abs_height.": 5 } ], "收件人姓名": "s***********", "allow_signing": true, "action_status": "UNOPENED", "recipient_phonenumber": "", "recipient_countrycode": "" } ] }, "status": "success" }
争论
|
data
jsonobject.
templates
jsonobject.
request_name
细绳
默认情况下，需要创建文档的名称与模板名称相同。
notes
细绳
要发送给所有收件人的消息
field_data
jsonobject.
预先填充字段数据
field_text_data
jsonobject {“field_label”:“field_value”}
文本字段数据
field_boolean_data
jsonobject {“field_label”:“field_value”}
复选框数据
field_date_data
jsonobject {“field_label”:“field_value”}
日期字段数据
标准日期现场格式DD MMMM YYYY（前：2019年1月1日）
actions
杰森阵列
收件人列表
recipient_name
细绳
收件人姓名
recipient_email
细绳
收件人电子邮件
private_notes
细绳
每个收件人的私人笔记
verify_recipient
布尔基
需要进行身份验证或未完成
verification_type
细绳
验证模式[电子邮件]
is_quicksend
布尔基
快速发送
|
删除模板
放 //sign.hqwacp.icu/api/v1/templates/[Template ID]/delete
删除模板将其移动到垃圾中。
请求示例
$ curl //sign.hqwacp.icu/api/v1/templates/[Template ID]/delete \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Template deleted successfully", "status": "success" }
Webhook管理
在Zoho标志中发生行动时，Webhook可用于通知第三方URL。通过轮询，Zoho标志本身将积极检查文档的状态，而是在互动发生时向您发送通知。这是通过将POST请求发送到您在特定操作发生时指定的URL来实现的。您的服务器/应用程序必须返回收到请求后的HTTP 200响应。
For every configured action, the 邮政 request made to your URL will have the format as shown below: { "要求": { "Request_status.": "declined", "笔记": "", "提醒_Period.": 4, "owner_id": "49000000002002", "description": "", "Request_name.": "Testing", "modified_time": 1553079267113, "action_time": 1555062602046, "is_deleted": false, "expiration_days.": 30, "is_equential.": true, "sign_submitted_time": 1553079268530, "owner_first_name": "N********H", "sign_percentage": 0, "expire_by": 1555698540000, "owner_email": "n*****@*****.com", "created_time": 1553079267113, "Email_Reminders.": true, "document_id.s": [{ "document_name": "test.pdf;", "document_size": 43317, "document_order": "0", "total_pages": 1, "document_id.": "49000000752049" }], "self_sign": false, "in_process": false, "validity": -1, "Request_type_name.": "Others", "decline_reason": "", "request_id": "49000000752055", "Request_type_id.": "49000000000187", "owner_last_name": "", "行动": [{ "验证_recipient.": false, "action_type.": "SIGN", "private_notes.": "", "收件人电子邮件": "n*****@*****.com", "allow_signing": false, "recipient_phonenumber": "", "is_bulk": false, "action_id.": "49000000752058", "is_revoked": false, "is_embedded": false, "signing_order.": 0, "收件人姓名": "N********H", "action_status": "DECLINED", "recipient_countrycode": "+91" }] }, "notifications": { "performed_by_email": "n****@****.com", "performed_at": 1555062604837, "reason": "I want to", "activity": "Document has been declined", "operation_type": "RequestRejected", "action_id.": 49000000752058, "performed_by_name": "N******H", "signing_order.": 0, "ip_address": "172.24.105.68" } }
OAuthscopes.
zohosign.account.create，zohosign.account.read，zohosign.account.update
添加webhook.
邮政 //sign.hqwacp.icu/api/v1/accounts/webhooks
这将帮助您为您的帐户创建Webhook。
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'webhook_url=https*****&webhook_actions=Sign,Completed,Forward,Decline,Recalled,Expired&purpose=Test'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "webhook": { "webhook_url.": "https*****", "webhook_id": "200000000363", "webhook_actions.": "Sign,Completed,Forward,Decline,Recalled,Expired" }, "message": "Webhook created successfully", "status": "success" }
争论
|
webhook_url
细绳
要调用的WebHook URL
webhook_actions
细绳
您希望发送Webhook电话的符号中的操作。逗号分隔的字符串，允许值
标志|拒绝|向前|完成|召回|已过期|浏览
purpose
细绳
创建webhook的目的 - 为您提供参考
|
更新Webhook.
放 //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook ID]
这将帮助您更新帐户中特定Webhook的详细信息。 您只需通过要更新的值。不需要其他值。
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks[Webhook ID] \ -X PUT \ -H "Authorization: Zoho-oauthtoken <Oauth Token>" \ -d 'webhook_url=https*****&webhook_actions=Sign,Completed,Forward,Decline,Recalled,Expired&purpose=Test'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "webhook": { "webhook_url.": "https*****", "webhook_id": "200000000363", "webhook_actions.": "Sign,Completed,Forward,Decline,Recalled,Expired" }, "message": "Webhook created successfully", "status": "success" }
争论
|
webhook_url
细绳
要调用的WebHook URL
webhook_actions
细绳
您希望发送Webhook电话的符号中的操作。逗号分隔的字符串，允许值
标志|拒绝|向前|完成|召回|已过期|浏览
purpose
细绳
创建webhook的目的 - 为您提供参考
|
获取特定Webhook的详细信息
得到 //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]
使用Webhook ID获取特定Webhook的详细信息。
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id] \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "webhook": { "webhook_url.": "//***********", "webhook_id": "200000836363", "目的": "test", "webhook_status": "Active", "webhook_actions.": "Sign,Decline,Forward,Completed,Recalled,Recalled,Expired,Viewed" }, "message": "Webhook retrieved successfully", "status": "success" }
获取Webhook列表
得到 //sign.hqwacp.icu/api/v1/accounts/webhooks
这将帮助您获取帐户中的Webhook列表。
请求示例
$ curl -G //sign.hqwacp.icu/api/v1/accounts/webhooks \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"\ --data-urlencode 'data={"page_context.":{"row_count.":10,"start_index.":1,"search_columns":{},"sort_column.":"created_time","排序":"DESC"}}'
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "webhooks": [ { "webhook_url.": "//********", "webhook_id": "200000836353", "目的": "adf", "webhook_status": "Active", "webhook_actions.": "Sign,Decline,Forward,Completed,Recalled,Recalled,Expired" }, { "webhook_url.": "//********", "webhook_id": "200000836363", "目的": "test", "webhook_status": "Active", "webhook_actions.": "Sign,Decline,Forward,Completed,Recalled,Recalled,Expired,Viewed" } ], "message": "Webhooks list retrieved successfully", "status": "success" }
争论
停用Webhook.
邮政 //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]/unsubscribe
如果您不再需要在特定的Webhook URL上接收更新，请停用Webhook。 This doesn’t删除WebHook，可以稍后再次激活它。
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]/unsubscribe \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Webhook deactivated", "status": "success" }
重新激活webhook.
邮政 //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]/activate
如果已停用Webhook，则可以使用此呼叫再次重新激活它
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]/activate \ -X POST \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Webhook activated", "status": "success" }
删除Webhook.
删除 //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id]
这将帮助您永久从您的帐户中删除WebHook，使用Webhook ID
请求示例
$ curl //sign.hqwacp.icu/api/v1/accounts/webhooks/[Webhook Id] \ -X DELETE \ -H "Authorization: Zoho-oauthtoken <Oauth Token>"
反应示例
HTTP/1.1 200 好的 Content-Type:application/json;charset=UTF-8 { "代码": 0, "message": "Webhook deleted successfully", "status": "success" }