Dokobit 通用 API

Dokobit 通用 API 是一种通用的工具，可用于在系统中、系统中内部对文档进行签名，以及从整个欧洲系统外部的第三方收集签名。文档签名发生在无帐户的 Dokobit 签名（邀请的参与者可以在 Dokobit 门户上注册文档）界面上与组织的品牌进行签名。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	Dokobit
URL	https://support.dokobit.com
Email	developers@dokobit.com

连接器元数据
发布者	Dokobit
网站	https://www.dokobit.com/solutions
隐私策略	https://www.dokobit.com/compliance/privacy-policy
类别	生产力

先决条件

若要使用 Dokobit 通用 API，请与我们联系 sales@dokobit.com 以获取 API 访问令牌。

如何获取凭据

请与销售部门联系以获取 API 访问令牌

连接器入门

可以使用“DokobitUniversalAPICreateExternalSigning”或“DokobitUniversalAPICreateInternalSigning”作启动文档签名。使用“DokobitUniversalAPICreateExternalSigning”将向参与者发送签名邀请。 “DokobitUniversalAPICreateInternalSigning”将生成可重定向用户的签名 URL。
然后，可以使用相应的作来管理签名，以便添加/删除参与者、发送提醒或检查文档签名状态。
参与者签署文档后，可以使用“DokobitUniversalAPIDownloadDocumentExternal”或“DokobitUniversalAPIDownloadDocumentInternal”作下载该文档。

已知问题和限制

当前实现支持对 PDF 文件进行签名收集，并由 ASiCe、ADoc、BDoc 或 EDoc 容器支持。

常见错误和补救措施

文件必须作为 Base64 编码的文件内容提供。
如果将文档签名“Type”设置为“pdf”，则启动文档签名时将接受单个 PDF 文档。对于多个文件，请将签名“Type”设置为“asice”或其他容器格式。

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API 密钥	securestring	此 API 的 API 密钥	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

Validation	Dokobit 是经过 eIDAS 认证的服务提供商，用于进行合格的电子签名和电子密封验证。使用此作上传已签名的文件进行验证。支持的文件类型：`asice`、、、`asicsscebdoc`、`edoc`、。 `xmlpdfp7s`
下载文档内部	下载已签名的文档。
下载文档外部	下载已签名的文档。
创建内部签名	内部签名从系统启动签名请求。在这种情况下，将生成应重定向参与者的签名 URL。
创建外部签名	外部签名从系统启动异步签名请求。在这种情况下，用户会收到一封电子邮件进行签名，一旦他签署文档，你将收到回调。
删除内部签名	文档将从所有者的帐户中删除。其他参与者仍可访问它。
删除内部签名者	对于所指示的参与者，将撤销对文档的访问权限。
删除外部签名	文档将从所有者的帐户中删除。其他参与者仍可访问它。
删除外部签名者	对于所指示的参与者，将撤销对文档的访问权限。
印章签名	文档将用组织的电子印章密封。请联系我们的支持人员 developers@dokobit.com 以获取电子密封的合格证书。
发送提醒	仅当人员尚未签署文档时，才允许为参与者发送提醒电子邮件。仅适用于外部签名流。
更新内部签名	允许更新现有文档签名的属性。
更新外部签名	允许更新现有文档签名的属性。
检查内部签名状态	返回具有签名状态的文档信息。
检查外部签名状态	返回具有签名状态的文档信息。
添加内部签名者	指示参与者将获得对具有所选角色的文档的访问权限。
添加外部签名者	指示参与者将获得对具有所选角色的文档的访问权限。
电子交付	文档电子交付用于使用 Dokobit 通用 API 安全地共享文档。
验证 - PDF 报告	以 PDF 格式下载验证报告。
验证 - XML 报告	在 XML 中下载验证报告。
验证 - XML 诊断数据	在 XML 中下载诊断数据。
验证 - 详细的 PDF 报告	以 PDF 格式下载详细的验证报告。

Validation

操作 ID:: DokobitUniversalAPIValidation

Dokobit 是经过 eIDAS 认证的服务提供商，用于进行合格的电子签名和电子密封验证。使用此作上传已签名的文件进行验证。支持的文件类型：asice、、、asicsscebdoc、edoc、。 xmlpdfp7s

参数

名称	密钥	必需	类型	说明
Name	name	True	string	文件名。
Content	content	True	string	Base64 编码的文件内容。

名称	路径	类型	说明
上传状态	status	string	上传状态。
验证令牌	token	string	验证令牌。

下载文档内部

操作 ID:: DokobitUniversalAPIDownloadDocumentInternal

下载已签名的文档。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

response: object

下载文档外部

操作 ID:: DokobitUniversalAPIDownloadDocumentExternal

下载已签名的文档。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

response: object

创建内部签名

操作 ID:: DokobitUniversalAPICreateInternalSigning

内部签名从系统启动签名请求。在这种情况下，将生成应重定向参与者的签名 URL。

参数

名称	密钥	必需	类型	说明
类型	type	True	string	文档格式。可用值：`pdf`、、`asice`、`edocbdoc`、`adoc`。 `adoc.cedoc`
Name	name	True	string	为用户显示的签名名称。
重定向 URI	redirect_uri	True	string	签名完成后将用于重定向签名者的重定向 URI。
回发 URL	postback_url		string	用于处理 Webhook 的系统 URL。
需要限定的签名	require_qualified_signatures		boolean	仅允许使用限定签名进行签名。默认值：`false`。
批注位置	annotation_position		string	可以选择 PDF 文档上的签名批注的位置。可用值：`first_top`、、`last_topfirst_bottom`、`last_bottomnone`。默认值：`first_top`。
批注个人代码	annotation_personal_code		boolean	如果设置为 `true` 个人代码，将在批注中可见。仅适用于 PDF 类型签名。默认值：`false`。
允许视频识别	allow_video_identification		boolean	允许使用基于视频的标识进行签名。默认值：`false`。
平展 PDF	flatten_pdf		boolean	如果设置为 true，文档将被平展，以便表单字段成为文档内容的一部分，并且无法在签名后进行编辑。仅适用于 PDF 类型签名。默认值：`false`。
允许的签名方法	allowed_signing_methods		array of string	仅允许特定的签名方法。可用值：`mobile`、、`smartid`、、`smartcard`、`eparaksts_mobile`、`audkenni_appmitidbankid_noitsmeelectronic_idbankid_seftn`、`idin`、。 `swisscomsms_otp`
Name	name	True	string	文件名。
Content	content	True	string	Base64 编码的文件内容。
外部 ID	external_id	True	string	系统中参与者的唯一随机标识符。如果没有随机标识符，可以生成唯一的随机标识符。
角色	role		string	参与者的角色。可用值： `signer`， `viewer`。默认值：`signer`。
Code	code		string	参与者的代码。
国家/地区代码	country_code		string	参与者的国家/地区代码。提供个人代码时是必需的。可用值：`LT`、、`LV`、`EE`、`IS`、`PLNOFI`、。 `SEBE`
电话	phone		string	参与者的电话。
通知语言	language		string	设置用户界面语言。可用值：`en`、、`lt`、`lv`、、`nofi`。 `nldketisfrsede`
页	page		string	可见 PDF 签名注释的页面索引。仅适用于 PDF 类型签名。默认值：`1`。
从顶部的位置	top		string	位置（以磅为单位），从顶部显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
从左位置	left		string	从左侧位置（以磅为单位）显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
语言	language		string	可见 PDF 签名注释的语言。仅适用于 PDF 类型签名。可用值：`en`、、`lvlt`、`et`、`is`
自定义原因	custom_reason		string	自定义签名原因。

名称	路径	类型	说明
状态	status	string	状态。
签名令牌	token	string	签名令牌。
签名	signers	array of object	参与者的信息。
外部 ID	signers.external_id	string	系统中参与者的唯一随机标识符。
标记	signers.token	string	参与者的令牌。
重定向 URI	signers.redirect_uri	string	要签名的 URL。

创建外部签名

操作 ID:: DokobitUniversalAPICreateExternalSigning

外部签名从系统启动异步签名请求。在这种情况下，用户会收到一封电子邮件进行签名，一旦他签署文档，你将收到回调。

参数

名称	密钥	必需	类型	说明
类型	type	True	string	文档格式。可用值：`pdf`、、`asice`、`edocbdoc`、`adoc`。 `adoc.cedoc`
Name	name	True	string	为用户显示的签名名称。
回发 URL	postback_url		string	用于处理 Webhook 的系统 URL。
截止时间	deadline		date-time	使用指定的时区片段对截止时间日期进行签名。示例：2018-11-05T13：15：30Z。
硬截止时间	hard_deadline		boolean	如果设置为 `true` 参与者，则无法在设置 `deadline`后对此文档进行签名。默认值：`false`。
需要限定的签名	require_qualified_signatures		boolean	仅允许使用限定签名进行签名。默认值：`false`。
批注位置	annotation_position		string	可以选择 PDF 文档上的签名批注的位置。可用值：`first_top`、、`last_topfirst_bottom`、`last_bottomnone`。默认值：`first_top`。
批注个人代码	annotation_personal_code		boolean	如果设置为 `true` 个人代码，将在批注中可见。仅适用于 PDF 类型签名。默认值：`false`。
注释	comment		string	参与者的消息。
允许视频识别	allow_video_identification		boolean	允许使用基于视频的标识进行签名。默认值：`false`。
允许保存文档	allow_document_saving		boolean	允许用户将文档保存到 Dokobit 门户并执行进一步作。默认值：`true`。
平展 PDF	flatten_pdf		boolean	如果设置为 true，文档将被平展，以便表单字段成为文档内容的一部分，并且无法在签名后进行编辑。仅适用于 PDF 类型签名。默认值：`false`。
允许的签名方法	allowed_signing_methods		array of string	仅允许特定的签名方法。可用值：`mobile`、、`smartid`、、`smartcard`、`eparaksts_mobile`、`audkenni_appmitidbankid_noitsmeelectronic_idbankid_seftn`、`idin`、。 `swisscomsms_otp`
Name	name	True	string	文件名。
Content	content	True	string	Base64 编码的文件内容。
外部 ID	external_id	True	string	系统中参与者的唯一随机标识符。如果没有随机标识符，可以生成唯一的随机标识符。
Name	name		string	参与者的姓名。
Surname	surname		string	参与者的姓氏。
电子邮件	email		string	参与者的电子邮件。
Code	code		string	参与者的个人代码（国家 ID 号码）。
国家/地区代码	country_code		string	参与者的国家/地区代码。提供个人代码时是必需的。可用值：`LT`、、`LV`、`EE`、`NOIS`、`FI`、 `BE`。 `SE`
角色	role		string	参与者的角色。可用值： `signer`， `viewer`。默认值：`signer`。
公司	company		string	参与者的公司名称。
Position	position		string	参与者的位置。
电话	phone		string	参与者的电话号码。
序列	sequence		integer	允许设置文档审批和签名作的顺序顺序。
通知语言	notifications_language		string	设置通知的语言。可用值：`en`、、`lt`、`lv`、、`nofi`。 `nldketisfrsede`
自定义原因	custom_reason		string	自定义签名原因。
页	page		string	可见 PDF 签名注释的页面索引。仅适用于 PDF 类型签名。默认值：`1`。
从顶部的位置	top		string	位置（以磅为单位），从顶部显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
从左位置	left		string	从左侧位置（以磅为单位）显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
语言	language		string	可见 PDF 签名注释的语言。仅适用于 PDF 类型签名。可用值：`en`、、`lvlt`、`et`、`is`

名称	路径	类型	说明
状态	status	string	状态。
签名令牌	token	string	签名令牌。
签名	signers	array of object	参与者的信息。
外部 ID	signers.external_id	string	系统中参与者的唯一随机标识符。
标记	signers.token	string	参与者的令牌。
Name	signers.first_name	string	参与者的姓名。
Surname	signers.last_name	string	参与者的姓氏。
Code	signers.code	string	参与者的个人代码（国家 ID 号码）。
国家	signers.country	string	参与者的国家/地区。
电子邮件	signers.email	string	参与者的电子邮件。

删除内部签名

操作 ID:: DokobitUniversalAPIDeleteInternalSigning

文档将从所有者的帐户中删除。其他参与者仍可访问它。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

名称	路径	类型	说明
状态	status	string	状态。

删除内部签名者

操作 ID:: DokobitUniversalAPIDeleteInternalSigner

对于所指示的参与者，将撤销对文档的访问权限。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
标记	token	True	string	参与者的令牌。

名称	路径	类型	说明
状态	status	string	状态。

删除外部签名

操作 ID:: DokobitUniversalAPIDeleteExternalSigning

文档将从所有者的帐户中删除。其他参与者仍可访问它。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

名称	路径	类型	说明
状态	status	string	状态。

删除外部签名者

操作 ID:: DokobitUniversalAPIDeleteExternalSigner

对于所指示的参与者，将撤销对文档的访问权限。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
标记	token	True	string	参与者的令牌。

名称	路径	类型	说明
状态	status	string	状态。

印章签名

操作 ID:: DokobitUniversalAPISealSigning

文档将用组织的电子印章密封。请联系我们的支持人员 developers@dokobit.com 以获取电子密封的合格证书。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
自定义原因	custom_reason		string	自定义签名原因。
页	page		string	可见 PDF 签名注释的页面索引。仅适用于 PDF 类型签名。默认值：`1`。
从顶部的位置	top		string	位置（以磅为单位），从顶部显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
从左位置	left		string	从左侧位置（以磅为单位）显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。

名称	路径	类型	说明
状态	status	string	状态。

发送提醒

操作 ID:: DokobitUniversalAPIReminder

仅当人员尚未签署文档时，才允许为参与者发送提醒电子邮件。仅适用于外部签名流。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
签名者令牌	signer	True	string	参与者的令牌。
Message	message		string	提醒签名者的消息。

名称	路径	类型	说明
状态	status	string	状态。

更新内部签名

操作 ID:: DokobitUniversalAPIUpdateInternalSigning

允许更新现有文档签名的属性。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
需要限定的签名	require_qualified_signatures		boolean	仅允许使用限定签名进行签名。默认值：`false`。
允许视频识别	allow_video_identification		boolean	允许使用基于视频的标识进行签名。默认值：`false`。
允许的签名方法	allowed_signing_methods		array of string	仅允许特定的签名方法。可用值：`mobile`、、`smartid`、、`smartcard`、`eparaksts_mobile`、`audkenni_appmitidbankid_noitsmeelectronic_idbankid_seftn`、`idin`、。 `swisscomsms_otp`

名称	路径	类型	说明
状态	status	string	状态。

更新外部签名

操作 ID:: DokobitUniversalAPIUpdateExternalSigning

允许更新现有文档签名的属性。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
截止时间	deadline		date-time	使用指定的时区片段对截止时间日期进行签名。示例：2018-11-05T13：15：30Z。
硬截止时间	hard_deadline		boolean	如果设置为 `true` 参与者，则无法在设置 `deadline`后签署或批准此文档。默认值：`false`。
需要限定的签名	require_qualified_signatures		boolean	仅允许使用限定签名进行签名。默认值：`false`。
允许视频识别	allow_video_identification		boolean	允许使用基于视频的标识进行签名。默认值：`false`。
允许保存文档	allow_document_saving		boolean	允许用户将文档保存到 Dokobit 门户并执行进一步作。默认值：`true`。
允许的签名方法	allowed_signing_methods		array of string	仅允许特定的签名方法。可用值：`mobile`、、`smartid`、、`smartcard`、`eparaksts_mobile`、`audkenni_appmitidbankid_noitsmeelectronic_idbankid_seftn`、`idin`、。 `swisscomsms_otp`

名称	路径	类型	说明
状态	status	string	状态。

检查内部签名状态

操作 ID:: DokobitUniversalAPICheckInternalSigningStatus

返回具有签名状态的文档信息。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

名称	路径	类型	说明
签名状态	status	string	文档签名状态。
Name	name	string	为用户显示的签名名称。
类型	type	string	文档类型。
创建日期	date_created	string	启动文档签名的日期。
截止时间	deadline	date-time	使用指定的时区片段对截止时间日期进行签名。示例：2018-11-05T13：15：30Z。
文件名	filename	string	文件的名称。
文件存储	files	array of object
Name	files.name	string	文件名。
下载 URL	files.url	string	文件下载 URL。
MIME 类型	files.mime_type	string	文件 MIME 类型。
签名	signers	array of object	参与者信息。
标记	signers.token	string	参与者的令牌。
Name	signers.first_name	string	参与者的姓名。
Surname	signers.last_name	string	参与者的姓氏。
Code	signers.code	string	参与者的代码。
国家	signers.country	string	参与者的国家/地区。
电子邮件	signers.email	string	参与者的电子邮件。
类型	signers.type	string	类型。
状态	signers.status	string	参与者的状态。

检查外部签名状态

操作 ID:: DokobitUniversalAPICheckExternalSigningStatus

返回具有签名状态的文档信息。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。

名称	路径	类型	说明
签名状态	status	string	文档签名状态。
Name	name	string	为用户显示的签名名称。
类型	type	string	文档类型。
创建日期	date_created	string	启动文档签名的日期。
截止时间	deadline	date-time	使用指定的时区片段对截止时间日期进行签名。示例：2018-11-05T13：15：30Z。
文件名	filename	string	文件的名称。
文件存储	files	array of object
Name	files.name	string	文件名。
下载 URL	files.url	string	文件下载 URL。
MIME 类型	files.mime_type	string	文件 MIME 类型。
签名	signers	array of object	参与者信息。
标记	signers.token	string	参与者的令牌。
Name	signers.first_name	string	参与者的姓名。
Surname	signers.last_name	string	参与者的姓氏。
Code	signers.code	string	参与者的代码。
国家	signers.country	string	参与者的国家/地区。
电子邮件	signers.email	string	参与者的电子邮件。
类型	signers.type	string	类型。
状态	signers.status	string	参与者的状态。

添加内部签名者

操作 ID:: DokobitUniversalAPIAddInternalSigner

指示参与者将获得对具有所选角色的文档的访问权限。

参数

名称	密钥	必需	类型	说明
签名令牌	token	True	string	签名令牌。
外部 ID	external_id	True	string	系统中参与者的唯一随机标识符。如果没有随机标识符，可以生成唯一的随机标识符。
角色	role		string	参与者的角色。可用值： `signer`， `viewer`。默认值：`signer`。
Code	code		string	参与者的代码。
国家/地区代码	country_code		string	参与者的国家/地区代码。提供个人代码时是必需的。可用值：`LT`、、`LV`、`EE`、`IS`、`PLNOFI`、。 `SEBE`
电话	phone		string	参与者的电话。
通知语言	language		string	设置用户界面语言。可用值：`en`、、`lt`、`lv`、、`nofi`。 `nldketisfrsede`
页	page		string	可见 PDF 签名注释的页面索引。仅适用于 PDF 类型签名。默认值：`1`。
从顶部的位置	top		string	位置（以磅为单位），从顶部显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
从左位置	left		string	从左侧位置（以磅为单位）显示可见的 PDF 签名批注。仅适用于 PDF 类型签名。默认值：`1`。
语言	language		string	可见 PDF 签名注释的语言。仅适用于 PDF 类型签名。可用值：`en`、、`lvlt`、`et`、`is`
自定义原因	custom_reason		string	自定义签名原因。

名称	路径	类型	说明
状态	status	string	状态。
签名	signers	array of object	参与者的信息。
外部 ID	signers.external_id	string	系统中参与者的唯一随机标识符。
标记	signers.token	string	参与者的令牌。
Name	signers.name	string	参与者的姓名。
Surname	signers.surname	string	参与者的姓氏。
电子邮件	signers.email	string	参与者的电子邮件。
Code	signers.code	string	参与者的个人代码（国家 ID 号码）。
国家/地区代码	signers.country_code	string	参与者的国家/地区。
角色	signers.role	string	参与者的角色。
公司	signers.company	string	参与者的公司。
Position	signers.position	string	参与者的位置。
电话	signers.phone	string	参与者的电话。

添加外部签名者

操作 ID:: DokobitUniversalAPIAddExternalSigner