集成与 REST API:运作方式
«Integrations & API» 让其他软件可以使用您的数据。通过 API 密钥,另一个系统可以读取客户、潜在客户、报价单、发票、订单和产品,并能创建其中的一部分;webhook 则会在这里发生某件事的那一刻通知另一个系统。可以用它连接会计工具、自动化服务或您自己的应用。
第 2 课,共 9 课 · 运作方式
运作方式
«System → Integrations → Integrations & API» 页面顶部显示四个数字:«Active keys»(有效密钥)、«Endpoints»(端点)、«Delivered (7 d)»(7 天内已送达)和 «Failed»(失败)。下方是 «API keys»、«Webhook endpoints» 和 «Event catalog» 三个面板。
点击 «Create key»,起一个能说明用途的名称,勾选它的权限范围,如有需要再设置到期日期。权限范围就是读取或写入某一类记录的权利,写入权限包含读取权限。
新密钥只会在 «Your new API key» 下显示一次,请立即复制:系统只保存它的指纹,之后无法再显示。
另一个系统在每次请求时都要带上这个密钥。它可以列出和读取客户、潜在客户、报价单、发票、订单和产品,也可以创建客户、潜在客户、报价单草稿和发票草稿。
通过 API 创建的潜在客户会触发与网站表单相同的消息。通过 API 创建的报价单和发票一律是草稿,税额按管理后台编辑器的方式计算。API 永远不会发送它们,也不会把它们标记为已付款。
每一行密钥显示其权限范围、创建人、请求次数和最后使用时间,并带有 «Active»、«Expired» 或 «Revoked» 标记。«Revoke» 会立即停用该密钥。
«API docs» 为开发人员打开完整的参考文档,«Delivery log» 打开 webhook 推送记录列表。
在哪里找到
- System → Integrations → Integrations & API
/admin/integrations - Integrations & API → API docs
/admin/integrations/docs - Integrations & API → Delivery log
/admin/integrations/deliveries
影响它的设置
- Apps & modules (Automation & integrations)
/admin/apps
检查清单
继续之前,请确认您能够:
- 打开 System → Integrations → Integrations & API
- System → Integrations → Integrations & API 页面顶部显示四个数字:Active keys(有效密钥)、Endpoints(端点)、Delivered (7 d)(7…
- 点击 Create key,起一个能说明用途的名称,勾选它的权限范围,如有需要再设置到期日期。权限范围就是读取或写入某一类记录的权利,写入权限包含读取权限。
- 新密钥只会在 Your new API key 下显示一次,请立即复制:系统只保存它的指纹,之后无法再显示。
- 另一个系统在每次请求时都要带上这个密钥。它可以列出和读取客户、潜在客户、报价单、发票、订单和产品,也可以创建客户、潜在客户、报价单草稿和发票草稿。
提示和常见错误
- 密钥丢了?它无法找回。请撤销旧密钥,再创建一个新的。
- 请求因缺少权限范围被拒绝,说明创建密钥时没有勾选这项权利。请新建一个勾选了该范围的密钥。
- 一个密钥可以突发发出 300 个请求,之后每秒 5 个。请求过快的系统会被要求等待,同一地址反复被拒可能导致暂时封禁。
- 像对待密码一样对待密钥。给每个接入的系统单独一个密钥,这样撤销其中一个时不会影响其他系统。