API的安全机制
更新时间:2024-09-20
有以下的方式来保证数据 API 的安全性:
API 的 token
Sugar BI上的所有数据请求都在Sugar BI的后端通过 curl 的方式访问用户的 API,并且用户可以设置访问的 token,设置的 token 会作为查询参数附加在 API 请求的头文件 Header 中,格式为:Sugar-Token: yourToken
。这样,您在自己写的 API 程序中通过验证请求 Header 中的Sugar-Token
的正确如否来决定是否返回数据,从而保证只有Sugar BI的后端才能访问您的 API,防止您的 API 被别人恶意访问而导致数据泄漏。
token
可以在编辑空间信息的时候设定(当然,只有空间的管理员才能看见和修改):
想要知道图表在通过 API 拉取数据时到底在请求头 Header 中加了哪些信息,可以在图表数据中「调试」即可在弹框中看到具体的信息。
访问 IP 限制
如果您的 API 访问有 IP 白名单方式的限制(例如百度智能云、阿里云等厂商的云服务器都支持「安全组」这样的访问控制),需要给Sugar BI的机器 IP 进行授权,Sugar BI的机器 IP 列表可以「参见数据源的数据库授权」。