天聚数行API接口平台

为确保您安全、稳定地使用我们的API服务，本指南旨在为您提供清晰、实用的安全接入建议。本指南将重点说明如何通过后端服务器接入、利用IP白名单、严谨处理API响应数据等核心实践，构建可靠的应用集成。遵循这些最佳实践，不仅能有效保护您的API密钥和数据，还能增强应用的健壮性，帮助您从容应对潜在风险。

1、后端服务器接入 API

强烈建议您通过您的后端服务器来调用我们的 API，而不是直接在前端（如 Web 网站、小程序或移动应用客户端）进行调用。如果在前端代码（JavaScript, HTML, App Bundle）中直接使用API密钥，它们很容易被任何用户通过浏览器开发者工具、网络抓包工具（如 Fiddler, Wireshark）或反编译应用轻松获取。一旦密钥泄露，攻击者可以冒充您的应用滥用 API，可能导致您的账户被封禁、产生额外费用或数据被窃取。

推荐架构：后端代理模式

前端 (Client)：您的 Web 页面、App 客户端等。它只与您自己的后端服务器通信。

您的后端服务器：部署在您可控环境（如云服务器、容器）中的服务。

优势：

密钥安全：API 密钥仅存储在您安全的后端服务器上，不会暴露给最终用户。

集中控制：您可以在后端统一处理认证、限流、日志记录、错误处理等。

灵活性：后端可以对 API 响应进行验证、聚合或修改，以适应前端需求。

2、设置 IP 白名单

IP 白名单是一种安全机制，它只允许来自您预先指定的、受信任的公网 IP 地址或 IP 段的请求访问您的 API接口。为了进一步增强安全性，强烈建议您启用 IP 白名单功能（控制台 - 安全管理 - IP白名单）。并将您后端服务器（如云服务 ECS实例、负载均衡器或 NAT 网关等）公网 IP 地址添加到白名单列表中。保存设置之后，只有来自这些 IP 的请求才会被 API 服务接受。来自其他 IP 的请求将被拒绝（IP请求来源受限）。

重要提示

仅用于后端服务器：IP 白名单应配置为指向您的后端服务器的 IP，而不是最终用户的 IP。

高可用考虑：如果您有多个后端服务器或使用负载均衡，需要将所有相关服务器的 IP 或负载均衡器的 IP 加入白名单。

云服务 NAT：如果您的后端服务器通过 NAT 网关或 SNAT 网关访问公网，应使用该网关的公网 IP。

动态 IP 问题：避免设置终端用户的动态公网 IP，如家庭宽带用户。

3、使用 HTTPS协议

尽管本平台同时支持 HTTP 和 HTTPS 协议接入，但我们强烈建议您始终使用 HTTPS 协议来调用我们的 API。HTTPS 使用 SSL/TLS 协议对客户端与服务器之间传输的数据进行加密。这意味着您的 API 请求（包含密钥、参数等敏感信息）和响应数据在网络传输过程中是加密的，即使被第三方截获，也无法轻易读取内容。而且HTTPS 证书机制还可以验证您正在通信的服务器确实是我们的 API 服务，可以防止域名劫持或 DNS 污染导致请求被导向恶意站点。

4、设置 Referer白名单

通常小程序端请求数据会携带特定的Referer信息，您可以在小程序调用API时，在控制台安全管理中设置Referer白名单来限制访问。但同时需要注意的是，这并不是最安全的做法。虽然通过在小程序配置中指定允许访问API的Referer域名，可以阻止来自其他来源的请求。然而，这种方式存在一定的风险，因为Referer信息可能且非常容易被伪造或篡改。因此，这只能作为一种辅助性的防护措施，而不是主要的安全策略。

5、 不假设返回的数据都是完整的

绝对不要假设 API 的响应总是完整、有效或符合预期格式。尽管我们每天都会对API进行积极的监测和维护，但难以避免因网络问题、服务端临时故障、第三方软硬件升级或数据异常导致的意外响应。建议每次接收数据时都要检查关键字段是否存在及其类型是否正确。即使code状态码为200，也应确认返回的数据是否完整且符合业务逻辑需求。应当采取“白名单”的开发思维来设计和实现异常处理流程，即仅当数据满足预定义的标准或格式时才被视为有效。

6、关注平台公告与更新

及时关注平台公告与更新，平台可能会不定期发布安全升级、功能优化或接口变更等重要通知。为确保您的应用稳定运行并持续符合安全要求，建议您主动订阅官方通知渠道（如绑定注册邮箱、关注微信服务号（天聚数行API）等），第一时间获取更新信息，并及时调整集成方案，避免因接口变动或安全策略升级导致服务异常。