帮助中心集成

为了: 管理员

使用中心密钥发送电子签名和读取签名

从模板创建案例的电子签名,选择每个字段的签名人,发布以供签名,并在所有人签名后下载锁定副本。

在本文中9 个部分

开始之前

此页面介绍了如何发送电子签名电子签名 一份用于电子签名的文件,已在浏览器中签名。,并在签名之后使用中心密钥进行验证。相关操作细节请参见https://prd-api-app.caseactive.com/v1/<hub id>/<case id>部分。

电话

称呼它的作用
GET /signs/templates列出您的电子签名模板
POST /signs为该案例创建一份电子签名,目前尚未发布。
PUT /signs/<sign_id>/schema决定谁来签署每个字段的内容
PUT /signs/<sign_id>在发布之前,更改名称、发布日期或提醒信息
PUT /signs/<sign_id>/publish将其发布出去,然后发送给所有签署者。
GET /signs?filter=all列出了该案件的电子签名文件。
GET /signs/<sign_id>读取了一个电子签名,其状态为……
DELETE /signs/<sign_id>删除它,连同其签名一起。
GET /signs/<sign_id>/responses列出其签名信息
GET /signs/<sign_id>/responses/<response_id>读取了一个签名

电子签名的过程分为几个步骤:首先创建签名文件,然后确认每个字段的签署者是谁,最后再将其发布出去。在发布之前,签署者无法看到该文件的内容,也不会有人知道其存在。一旦文件被发布,就无法再对其进行任何修改了。

创建电子签名

GET /signs/templates 列出了您已发布的电子签名文件列表 模板模板 可重复使用的动态帖子、表单、电子签名、笔记或任务保存在库中,并复制到案例中。, 先列出最年长的那个人,然后依次介绍其他人。 asset_id, title, description, due_mins (从消息发送起,已经过了多少分钟了), notifications, 以及 role_field_participants, 每个字段后面的符号所代表的含义。

POST /signs 的接受值包括:

场地它的作用必需的默认
name电子签名的内容格式如下:由字母、数字、空格以及& ' - _ ( ) . /组合而成,不允许使用逗号或冒号。是的—
duration{"due_date": "2026-10-09T17:00:00-04:00"},包括其时区偏移量。电子签名不会重复:因此不允许使用重复规则。是的—
template{"owner": "host", "template_id": "<asset_id>"} 使用某个模板的文档以及签署者信息不没有
description附带有电子签名的通知文档不该模板的…
notifications提醒:{"names": ["days"], "values": [-1440]},每个数值表示截止日期前还有多少分钟时间剩余不使用该模板,或者不使用任何模板。
instant_notifyfalse在发布时不会发送任何请求,只会发出提醒信息。不该模板的内容,或者可以说就是true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

这回答了问题。 201 随着 sign_id. 模板中的文档正在后台被复制:请继续阅读电子签名部分,直到没有更多内容可读为止。 copying.

如果您希望自己上传PDF文件,可以无需使用template标签来创建电子签名文档。将PDF文件上传后,等待其准备就绪,然后再为其分配各个字段的权限;详情请参阅使用中心密钥上传和附加文件部分。

选择谁来签字

根据模板,每个字段都会被分配给案例中负责相应职责的成员。因此,首先需要将客户添加到案例中。电子签名的话…… field_participants 结果显示如下:每个字段的名称,以及签署该字段的用户ID。

要更改它,请将整个地图文件发送到PUT /signs/<sign_id>/schema:

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • 每个身份证明文件上的签名必须是由负责该案件的人员所签署的。虚拟助手无法进行签名操作。
  • 这些字段名称就是文档中的那些字段名称。
  • 这张地图取代了旧的地图:那些被留空的区域就不会有签名者出现。

出版

PUT /signs/<sign_id>/publish没有具体的值,其响应值为200。至少有一个字段必须拥有签名者;如果没有任何字段,则该字段将保持空值状态。

  • 每个签署者都会立即收到一封电子邮件,要求他们签名;如果签署者没有有效的电子邮件地址,则会通过短信方式通知他们进行签名操作。除非…… instant_notify 是 false. 它出现在他们的身上/周围 待办事项去做 箱子上列着你需要处理的事项清单,例如需要填写的表格、需要签署的文件或需要确认的事项。 以及出现在他们的门户通知中。
  • 提醒信息会在每次notifications时发送,直到他们签署协议为止。
  • 从案件中被移除的人停止了持有该物品。

签名之后

在所有人签名之后,电子签名的status字段将显示completed。而completed_on则标注了具体的时间,以UTC时间为准,例如2026-10-06T21:42:10.123456+00:00。在此之前,这些字段都为空。最后,responses用于将每个已签名的签名者映射到他们的response_id。

GET /signs/<sign_id>/responses 页面上列出了所有签署者的签名信息,按照签名时间排序。每个签名项包含以下信息:签署者的 user_id、签署时填写的字段内容 response.formFieldValues、签名位置 response.annotations、任何相关的签名图片 response.attachments,以及签署者使用的 IP 地址 response.ip。所有信息都集中显示在一个页面上。

每次有人签署文件时,负责处理此案的工作人员都会收到通知。而当签署好的文件准备好后,同样会通知相关人员。每个签署人也会在文件准备好时收到通知。

锁定副本

一旦所有人都签署了文件,就会生成一份包含所有签名在内的锁定版本文档。该文档在media.schemas.items下的条目会获得flat、路径以及flat_status、SUCCEEDED或FAILED等数值。可以将该文件下载为任何格式的文件;详情请参阅使用中心密钥上传和附加文件部分说明。

列出和删除

GET /signs 需求 filter: all 列出了该案件中的所有电子签名记录,包括尚未发布的签名在内,按最新顺序排列; self 列出那些由虚拟助手发送的内容,这些内容可以通过任何方式触发,比如通过用户手动操作或自动化程序。 completed 以及 uncompleted 列出呼叫者的个人信息,这样对于钥匙来说,这些信息始终都是空白的:检查每一个电子签名 status 以及 completed_on 相反。

DELETE /signs/<sign_id>可以随时删除某个电子签名,并将其从所有人的待办事项列表中移除。没有人会知道这件事。

如果电话被拒绝

地位message为什么
400SchemaFieldsException某个字段缺失或无效,例如name中的逗号格式不正确,或者存在重复的规则定义,又或者签名者并不属于该案例;errors中提到了这个字段。
400SchemaFieldsException,其中ItemCopyNotAllowedException位于template处该模板尚未发布,也无法被机器人角色访问,或者其文件目前仍在处理中。
403PublishAlreadyPublishedException它已经发表过了,所以无法再被修改。
403PublishAlreadyAnsweredException已经有人签了名了。
403PublishParticipantsMissingException没有任何字段拥有签名者信息。
403PublishMediaMissingException目前还没有相关的文档记录。
403PublishMediaNotReadyException该文档目前仍正在被复制或转换中。
403PublishMediaFailedException该文档未能成功转换格式。
403PublishDocumentUnreadableException该文档无法被阅读:请删除已电子签名的版本,然后重新创建一份。
403PublishDueTimePassedException到期日已经过去
403BotNotAllowedException有人试图签署它,或者想要删除某人的签名。
403CaseClosedException此案已经结案。
404ItemNotFoundException这种电子签名其实并不存在。

关于错误 bodies 以及其他代码格式,请参考 处理 API 错误和状态代码 的相关说明。

相关文章

了解 API 的功能了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。集成使用中心密钥发送表单并查看答案根据模板创建案件表格,发布给需要填写表格的人员,并阅读他们的回答。集成使用集线器密钥上传和附加文件获取上传地址,上传文件,将其附加到帖子、笔记、任务、表单或电子签名中,并下载案件文件。集成处理 API 错误和状态码阅读错误正文,了解 400、401、403、404、500 和 503 的含义,以及为什么您的密钥无法查看的项目会返回 404。集成