接入指南
接入指南
身份认证
所有 /open-api/v1/** 业务接口都使用 API Key 认证。Key 属于当前账户,不能通过这些业务接口创建。
获取 API Key
登录 IPBUNKER 控制台。如果该实例已开放 API Key 管理,可从控制台菜单进入 API Key 页面创建 Key,并在创建时安全保存仅显示一次的完整值。若页面未开放,请联系实例运营人员开通或提供 API 接入方式。
请使用当前实例签发的 Key 和当前实例的公开 API 域名;不同实例或环境的 Key 不混用。
权限范围
API Key 可访问所属账户已开放的 Open API 能力,不能访问控制台接口。应将其作为高权限凭证保护。IP 白名单启用时由账户下的 Key 共用,不按单个 Key 配置;钱包余额、库存等业务限制仍然生效。
请求头
每个请求发送一个 X-API-Key 请求头:
X-API-Key: <YOUR_API_KEY>
不要把 Key 放在 URL、请求体、Cookie 或浏览器代码中。
认证失败
Open API 正常处理认证失败时,HTTP 状态为 200,业务码为 400001:
{"code":400001,"msg":"Authentication failed.","data":null,"next":null}
请在控制台或向实例运营人员核对 Key 状态、到期时间及账户级 IP 白名单。不要记录完整 Key;怀疑泄露时立即吊销并更换。