密钥与环境
每次调用都需要在 Authorization 请求头中带上 API 密钥:
GET /v1/shipments HTTP/1.1Host: api.ga-oms.comAuthorization: Bearer ga_live_YOUR_KEY密钥由您的 Golden Arcus 对接人为您的账号创建,只提供一次。我们只保存密钥的摘要,不保存明文,因此之后任何人都无法再次查看。如果密钥遗失,请申请新密钥,旧密钥会被作废。
您可以申请多个密钥,例如每个系统一个;每个密钥都可以单独作废。
- 一个密钥对应一个账号,只能访问该账号的货物。
- 密钥带有权限范围。
shipments:read可查询货物、事件和订单;orders:write可下单、修改订单并上传订单文件。如需开通,请联系您的 Golden Arcus 对接人。 - 密钥只能通过 https 使用。通过 http 发起的调用会被拒绝,返回
https_required。
| 密钥前缀 | 适用环境 |
|---|---|
ga_live_ |
正式环境 https://api.ga-oms.com,您的真实货物 |
ga_test_ |
测试环境,货物为模拟数据。如需先在测试环境联调,请联系我们 |
密钥与环境不匹配时,调用会被拒绝,返回 wrong_environment,并说明该密钥适用的环境。
妥善保管密钥
Section titled “妥善保管密钥”- 请把密钥作为机密保存在服务器端,不要写进网页、手机 App 或代码仓库。
- 如果密钥可能已泄露,请立即联系我们,我们会作废旧密钥并签发新密钥。
- 密钥不是登录密码,不能用来登录货物看板。