API Key 管理

创建、轮换、撤销 API Key,生产与沙箱环境

接口总览 快速入门 套餐与订单 API Key 管理 Webhook 配置 SMS 映射 错误码表

环境与 Key 前缀

环境Key 前缀访问路径说明
生产sk-live-/open/v1/*真实调用税局引擎,计费
沙箱sk-sandbox-/open/v1/sandbox/*仿真环境,不触引擎不计费
交叉访问会被拦截:生产 Key 无法访问 sandbox 路径,沙箱 Key 无法访问生产路径。

创建 API Key

在控制台 → API Key 页面,点击"创建 API Key"按钮:

1. 选择环境(生产或沙箱)

2. 填写备注名称(便于识别用途)

3. 创建后立即显示完整 Key(仅此一次展示,请妥善保存)

Key 创建后只展示一次,之后只显示前缀和掩码(如 sk-live-****1234)。请立即复制保存。

轮换 API Key

当 Key 可能泄露或需要定期更换时,可以创建新 Key 并设置宽限期:

1. 创建新的 API Key

2. 将业务系统切换到新 Key

3. 撤销旧 Key(旧 Key 在宽限期内仍可用,宽限期后彻底失效)

宽限期默认 24 小时(86400 秒),可通过系统配置调整。

撤销 API Key

在 API Key 列表中,点击对应 Key 的"撤销"按钮即可。

撤销后 Key 立即失效(或在宽限期内逐步失效),无法再用于访问任何接口。

使用方式

所有开放接口需在请求头携带 X-API-Key

curl -H "X-API-Key: sk-live-xxxx" https://your-domain.com/open/v1/zhxx