身份认证
atoship API 使用 API 密钥对请求进行身份认证。你可以在控制台中查看和管理你的 API 密钥。
API 密钥
你的 API 密钥拥有多项权限,因此务必妥善保管。切勿将 密钥类 API 密钥暴露在公开可访问的位置,例如 GitHub、客户端代码等。
正式
ak_live_...当你准备好正式生成真实运单时,请使用正式模式密钥。
测试
ak_test_...在开发和测试阶段请使用测试模式密钥,不会生成任何真实运单。
对请求进行认证
身份认证通过 Authorization 请求头 使用 Bearer 令牌方式完成。
Authorization: Bearer ak_live_abc123...安全最佳实践
使用环境变量
将 API 密钥存放在环境变量中,而不要写死在代码里
定期轮换密钥
定期生成新密钥并吊销旧密钥
开发时使用测试密钥
切勿在开发或测试环境中使用正式密钥
限制密钥权限
为不同服务分别创建权限范围受限的独立密钥
认证错误
401
未授权(Unauthorized)
未提供有效的 API 密钥,或该密钥已被吊销
403
禁止访问(Forbidden)
该 API 密钥没有访问所请求资源的权限
GET
已认证的请求| 1 | "text-emerald-400">curl https://atoship.com/api/v1/account "text-emerald-400">\ |
| 2 | "text-blue-400">-H "Authorization: Bearer ak_live_abc123..." |
必需请求头
Authorization:Bearer ak_live_...
Content-Type:application/json
密钥前缀
ak_live_正式模式密钥(secret key)
ak_test_测试模式密钥(secret key)
pk_live_正式模式可公开密钥(publishable key)
pk_test_测试模式可公开密钥(publishable key)