开发者资源

从接入规范到生产实践

围绕认证、请求、限流、错误处理和密钥安全整理的本地开发指南，适合在正式编码前快速校准实现方式。

身份认证

每个请求都通过 Authorization 请求头携带 Bearer 密钥。不要把密钥放在查询参数或前端代码中。

HTTP Header

Authorization: Bearer bf_test_your_key

请求与响应统一使用 UTF-8 编码的 JSON。POST 请求必须明确发送 Content-Type。

基础地址

https://api.bluefox.local/v1

内容类型

application/json

建议超时

10 秒

追踪标识

响应头 X-Request-Id

列表接口默认每页 20 条。客户端应控制并发并在收到 429 后按提示退避。

HTTP 状态描述传输结果，业务 code 描述具体原因。记录 requestId 能显著缩短问题定位时间。

仅对网络中断、429 和 5xx 使用指数退避重试；参数错误与认证错误应直接修正请求。

把密钥视为密码。按环境和服务拆分密钥，定期轮换，并在发现异常调用时立即吊销。