子账户调用说明
一、 概述
为满足企业客户对API使用进行精细化管理的需求,快递100提供子账户管理功能。主账户(母公司/主团队)可以创建并管理多个子账户,实现资源隔离、独立计费与监控,提升团队协作效率与安全性。
核心功能特征:
- 独立身份认证:每个子账户拥有独立的 API鉴权参数,支持独立调用API。
- 资源与权限控制:主账户可设定子账户状态,随时停用子账户。
- 用量监控与计费:支持按子账户查询API调用量,统一由主账户结算费用。
- 安全隔离:每个子账户相互隔离,避免主账户泄露风险。
- 更新简单方便:子账户调用接口与主账户接口设计一致,只需要替换API调用url和鉴权参数,不需要大幅改动现有代码。
应用场景:
- 企业内部多团队协作:如开发、测试、市场团队需独立使用API。
- 多项目/客户隔离:为不同项目或终端客户创建独立子账户,便于管理与审计。
- 合作伙伴分发:将API能力以子账户形式安全提供给合作伙伴。
- 分级运营管理:集团型客户为不同分支机构分配独立账户。
二、 子账户管理流程
2.1 创建子账户
登录快递100企业管理后台,在我的信息->子账户管理位置进行子账户管理,您最多可以创建100个子账户。点击右上角【创建子账户】按键,弹出新建子账户弹窗。输入子账户名称之后,点击确定按键,即可成功创建子账户。注意,每个子账户名称需要保证唯一,且创建后不支持修改。
2.2 查看子账户调用参数
点击【查看详情】按键,弹出子账户详情。
您可以在子账户详情处查看对应的鉴权参数和当前子账户的状态。
2.3 使用子账户调用接口
目前子账户支持调用实时查询API、订阅推送API、地图查询API、地图订阅API、电子面单API、电子面单取消API、时效预测API,如您还希望使用子账户调用其他接口,请与您的专属客户经理联系。
| 接口 | 子账户请求url | 鉴权参数 | 接口文档 |
|---|---|---|---|
| 实时查询API | https://api.kuaidi100.com/gw/query | key + customer | https://api.kuaidi100.com/document/5f0ffb5ebc8da837cbd8aefc |
| 订阅推送API | https://api.kuaidi100.com/gw/poll | key | https://api.kuaidi100.com/document/5f0ffa8f2977d50a94e1023c |
| 地图查询API | https://api.kuaidi100.com/gw/map_query | key + customer | https://api.kuaidi100.com/document/5ff2c3e7ba1bf00302f5612e |
| 地图订阅API | https://api.kuaidi100.com/gw/map_poll | key | https://api.kuaidi100.com/document/603f47dfa62a19500e19866f |
| 电子面单API | https://api.kuaidi100.com/gw/eorder | key + secret | https://api.kuaidi100.com/document/dianzimiandanV2 |
| 电子面单取消API | https://api.kuaidi100.com/gw/cancel | key + secret | https://api.kuaidi100.com/document/dianzimiandanquxiao |
| 时效预测API | https://api.kuaidi100.com/gw/time | key + secret | https://api.kuaidi100.com/document/kuaidiyugushixiaojiekouwendang |
*子账户调用接口url只可以使用子账户鉴权参数进行调用,主账户调用接口url只可以使用主账户鉴权参数进行调用。
调用示例:使用子账户调用实时查询API,与主账户调用相比较,只需要替换请求url和鉴权参数。
curl --location --request POST 'https://api.kuaidi100.com/gw/query' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'param={"com":"yunda","num":"123456789","resultv2":"1"}' \
--data-urlencode 'customer=12333' \
--data-urlencode 'sign=B19DB55FF14E35488D780C172E19DF99'
2.4 查看子账户调用明细
在子账户详情,可以查看子账户调用详情,支持下载明细。
三、接口扣费逻辑
- 1、子账户的API调用次数不单独计费,计入主账户的总体用量,按主账户统一结算费用。
- 2、子账户和主账户扣费逻辑一致,按单号扣费,40天内同一单号多次调用不扣费。
- 3、多个子账户在40天内查询同一个单号时只扣一次费用,费用只记录在第一次提交单号的子账户上。
四、常见问题
Q1:子账户数量是否有限制?
目前单个账户最多支持创建100个子账户,如您有创建更多子账户的需求,请和您的客户经理联系。
Q2:停用子账户什么时候生效?
当您停用子账户后,会立即生效。停用子账户会导致无法使用子账户调用接口,请您谨慎操作。
Q3:怎么查看所有子账户的调用情况?
所有子账户的调用费用,都会统计在主账户上,您可以导出主账户的调用明细,即为所有子账户的调用情况。
Q4:我希望使用子账户调用短信API等接口,应该怎么操作?
目前仅支持使用子账户调用查询订阅、电子面单等接口。如您有其他接口诉求,请和客户经理联系。
Q5:我目前使用快递100提供的jar调用接口,如何设置使用子账户调用?
sdk更新后将支持使用子账户调用,目前暂时不支持。