自动化和集成

API 访问基础:Enterprise 集成如何设置

10 分钟阅读

在 Enterprise 套餐中,由您的 Admin 在 Settings 中设置 Webhooks;只读外部 API 在我们的团队审核范围后按集成授予。

高级10 分钟阅读

在 Enterprise 套餐中,TenancyDesk 提供两种连接您自有系统的方式,它们的设置方式不同。

Webhooks:由您的 Admin 设置

Webhooks 会在 TenancyDesk 中发生变化时通知您的系统。由您的 Admin 在 Settings → Webhooks 中添加——无需另行审批。每次推送都带有签名,您的系统用创建 Webhook 时显示的密钥验证签名。

外部 API:按集成授予

外部 API 让您的系统读取机构的记录;它是只读的。套餐让您可以申请它;它不会自行开启。

  1. 在 Settings → API Keys 中描述要连接哪些系统、需要哪些记录,然后按 Send request。
  2. 我们的团队审核范围并回复。
  3. 获得授权后,您的 Admin 在那里创建密钥。密钥只显示一次——请妥善保存。它只能访问贵公司的记录,可以限制在特定端点和 IP 地址,并设置到期日期。

从哪里开始

阅读 Developer API and Webhooks 页面,然后告诉我们您需要的工作流程。

分步指南

  1. 1

    Webhooks:在 Settings 中添加

    您的 Admin 在 Settings → Webhooks 中添加 Webhooks,并保存创建时显示的签名密钥。

  2. 2

    API:发送申请

    在 Settings → API Keys 中描述要连接哪些系统、需要哪些记录,然后按 Send request。

  3. 3

    API:等待审核

    我们的团队审核范围并回复。外部 API 是只读的。

  4. 4

    API:创建密钥

    获得授权后,您的 Admin 创建密钥;密钥只显示一次,且只能访问贵公司的记录。

这份指南对您有帮助吗?

准备付诸实践了吗?

开始14天免费试用,应用您所学的知识。

开始免费试用