通过 API 连接您的工具

API 让第三方应用能够以程序化方式访问您组织的数据：人员名册、日历、预订和账单。它只需两次点击即可启用，并通过一个密钥、一份授权地址清单以及用量跟踪来保障安全。

判断 API 是否适合您

API 面向开发人员，而非组织负责人。它的作用是让您的账户与某个由您委托编写或配置的软件进行对接：定制网站、会计工具、自制显示屏、通往其他系统的接口。

对于日常需求——获取会员名单、批量更新订阅、向理事会提交数据——导入、导出和报表模块无需编写任何代码即可满足。

API 目前以测试版提供：其运行方式仍可能变化。

启用 API 并获取您的密钥

1. 前往 管理›设置›API BETA。
2. 启用 启用API模块，然后点击 保存。
3. 您的 API密钥 会显示出来：用 复制 按钮复制它，并仅将其交给您要连接的工具。

该密钥需在每个请求的 HTTP 头 X-API-Key 中传递。所有调用必须使用 HTTPS；未加密的请求一概不予接受。

保护密钥

有几条基本原则，值得向使用该密钥的工具或服务商重申：

• 切勿将密钥放入代码仓库；应将其保存在仓库之外的配置文件或密钥管理工具中；
• 一旦工具从固定服务器发起调用，请立即限制授权地址；
• 只要存有疑虑就重新生成密钥——例如意外公开、日志泄露、服务商任务结束。

重新生成 按钮会要求确认，随后立即使旧密钥失效。所有使用旧密钥的应用在收到新密钥之前都将停止运行：请在点击之前通知它们。

按 IP 地址限制访问

启用 按IP地址限制：只有来自您所列出地址的请求才会被接受，最多可填写 10 个 IPv4 地址。逐个输入地址，然后用 添加 确认；屏幕上会显示您当前的地址以供参考。

这是最有效、也最常被忽视的防护措施：即使密钥被泄露，只要它被限制在您服务商的地址上，在其他地方仍然无法使用。

跟踪用量

该界面会持续显示您的密钥的用量：

• 当前使用中 和 今日使用情况，在已配置限额时，各自会与其限额一并显示；
• 用户手册：本周、本月、总计 和 最后请求。

超出所示限额后，额外的请求会被暂时拒绝。某个计数器长期贴近上限，通常说明工具配置不当，反复循环请求相同的数据，而没有对其做缓存。

最后一次请求的日期则可用于反向判断：一个已启用但数月未被调用的密钥，就是应当停用的密钥。

了解 API 能做什么

完整文档（含参数和调用示例）显示在该模块界面的底部。概括而言：

• 用户：这是唯一可修改的资源。您可以列出、查看、创建、修改和删除账户。
• 配置：订阅、资料、群组和年龄类别可以查看，但只能在应用中配置。
• 预订：日历、可用时段、预订和封锁标签可以查看。
• 账单：计费账户、订单和付款可以查看。