身份验证
AlphaFinance API使用API密钥进行身份验证,确保只有授权用户才能访问我们的数据服务。获取API密钥
要获取API密钥,您需要:- 在 AlphaFinance 创建一个账户
- 登录到 控制台
- 导航至”API密钥”部分
- 点击”创建新密钥”按钮
使用API密钥
在所有API请求中,您都需要包含API密钥。有两种方式可以做到这一点:方法一:请求头(推荐)
将API密钥添加到HTTP请求头中:方法二:查询参数
将API密钥作为URL查询参数:出于安全考虑,我们强烈建议使用请求头方法传递API密钥,特别是在生产环境中。
安全最佳实践
为保护您的API密钥和数据安全,请遵循以下最佳实践:- 不要在客户端代码中嵌入API密钥:前端JavaScript等客户端代码容易被查看,应通过后端服务器代理API请求。
- 使用环境变量:将API密钥存储在环境变量中,而不是直接写入代码。
- 定期轮换密钥:定期创建新密钥并废弃旧密钥,特别是在人员变动或安全事件后。
- 授予最小权限:只分配完成任务所需的最小权限。
- 监控API使用情况:定期检查API使用日志,及时发现异常活动。
速率限制
为确保服务质量,我们对API请求施加了速率限制。限制根据您的订阅计划而有所不同:
当您超过速率限制时,API将返回
429 Too Many Requests 状态码。响应头中的 X-Rate-Limit-Remaining 和 X-Rate-Limit-Reset 字段会告诉您剩余的请求次数和限制重置的时间。