跳到主要内容
帮助中心

分类

搜索帮助中心Ctrl K
本页内容

开发应用或接入 Webhook

创建供其他 Drime 用户连接到其账户的 OAuth 应用、接收 Webhook,并在您的服务器上接收 Drime Sign 事件通知。

更新于 Web

如果只是在您自己的账户上使用 Drime API,个人令牌就足够了:请参阅创建 API 令牌。如果要开发供其他 Drime 用户连接到其账户的应用,请创建 OAuth 应用:您的用户在 Drime 上授权该应用,应用永远不会接触到他们的密码。

#创建 OAuth 应用

任何已登录的用户都可以在开发者门户中,依次点击我的应用和创建应用来创建应用。

开发者门户中的“创建应用”表单,显示三种应用类型

首先,选择您要开发的内容:

选项

适用场景

网站或服务器

您会获得一个密钥,需保存在您的服务器上。

桌面或移动应用

安装在您用户的设备上,因此没有密钥。

仅供自己使用的脚本

您自己运行的小工具。

然后,选择应用需要访问的内容:专属文件夹(应用只能看到在云盘中为它创建的一个文件夹)或整个云盘。

补充说明:

  • 您最多可以创建 25 个应用。

  • 新应用最多可供 25 位用户使用。如需向更多人开放,请使用面向所有人开放,然后点击提交审核:Drime 会在 24 小时内答复。

  • 访问令牌的有效期为 1 小时,刷新令牌的有效期为 90 天。

  • 第三方应用永远无法访问 Vault。

网站或服务器类型的应用还可以在已连接的账户中有文件被创建或删除时接收 Webhook。每条通知都会在 X-Drime-Signature 请求头中签名。

#Drime Sign Webhook

在设置 > 开发人员 > Webhook(Drime Sign 事件的 HTTP 通知。)中,点击添加 Webhook,即可在发生以下事件时通知您的服务器,例如:

  • 文档已发送、已完成或被拒绝;

  • 签署人查看、签署或拒绝签署;

  • 创建了模板。

“开发人员”设置中的“Webhook”部分,带有“添加 Webhook”按钮

每条通知都使用密钥签名(X-Drime-Signature,HMAC SHA-256)。发送失败的通知会在约 34 小时内最多重试 10 次。您可以使用发送测试和更换密钥,并查看发送记录。

#在您的网站上嵌入签署表单

在设置 > 开发人员 > 嵌入中,您可以通过 <drime-sign-form> 组件,让访客无需离开您的网站即可签署文档。请在允许的域名中添加您的域名:如果未添加任何域名,嵌入功能将处于停用状态。

#后续步骤

这篇文章对您有帮助吗?