【无标题】快宝电子面单接口

快宝开放平台

首页
解决方案
产品
API文档
关于我们

开发者指南

13122911354

控制台

API文档

地址库服务
物流跟踪
云打印
电子面单
- 电子面单余量查询
- 回收电子面单
- 获取电子面单号（新）
微掌柜
短信服务
散客下单
基础服务

API文档/电子面单/电子面单余量查询

应用场景

查询电子面单号可申请的剩余数量；目前支持申通,中通,韵达,百世快递品牌，单号源类型为拼多多、淘宝、菜鸟物流云的面单余额查询

技术咨询请加微信：kuaibao135

接口名称

account.waybill.balance

公共参数

请求地址

环境名称	HTTPS请求地址
正式地址	https://kop.kuaidihelp.com/api

公共请求参数

名称	类型	是否必须	描述
method	string	是	API接口名称
app_id	string	是	用户ID（注册开放平台时分配，在控制台中查看）
sign	string	是	按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串，字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c
ts	string	是	当前请求的时间戳(10位或13位)
data	string	是	JSON格式请求参数

公共响应参数

名称	类型	是否必须	描述
code	int	是	响应状态码。0-成功，非0-失败下载并查看详情
msg	string	是	返回结果说明
uid	string	是	本次请求唯一业务流水号
data	string	是	JSON格式响应数据

请求参数

名称	类型	是否必须	描述
customer_name	string	是	若单号源为快递公司自有电子面单平台，此处填写快递公司提供的大客户帐号。如何申请大客户帐号？注：1. 申通快递此字段请填写：客户名称@快递网点名称，如：韩都衣舍@上海虹桥公司。2. 顺丰、邮政、EMS等不需要输入大客户帐号与密码。若单号源为淘宝、拼多多、菜鸟物流云等第三方平台，此字段统一填写为“xiaoyoutong”（不包含引号）。用户需要到”微快递小邮筒“微信公众号中授权第三方平台帐号，并将目标云打印机的访问密钥填到customer_password字段。授权流程请参考：授权第三方平台帐号。
customer_password	string	是	若单号源为快递公司自有电子面单平台，此处填写快递公司提供的大客户帐号密码。若单号源为第三方平台，此处填写授权了第三方帐号的云打印机的访问密钥。
customer_id	string	否	快递网点的客户编号
shipper_type	string	是	快递公司标识符，如：sto
site_flag	string	是	网点名称 (申通必填)

响应参数

名称	类型	是否必须	描述
count	string	是	剩余单数总数
shipper_type	string	是	品牌
item	array	是	不同号段的电子面单余额列表

请求示例

Java

Python

PHP

Node.js

Curl

import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;import java.util.Map;
import java.util.HashMap;import java.util.Date;public class Request {public static void main(String[] args) {
String host = "http://kop.kuaidihelp.com";
String path = "/api";
String requestMethod = "POST";
Map<String, String> headers = new HashMap<String, String>();
//根据API的要求，定义相对应的Content-Type
headers.put("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
Map<String, String> querys = new HashMap<String, String>();
Map<String, String> bodys = new HashMap<String, String>();String appId = "50001";
String method = "account.waybill.balance";
// 当前时间戳
String ts = new Date().getTime() + "";
String appKey = "bdf3b5f50865ac813cbdfd6c9b572b79";// 计算签名
String signStr = appId + method + ts + appKey;
String sign = Request.getMD5(signStr, 32);bodys.put("app_id", appId);
bodys.put("method", method);
bodys.put("ts", ts);
bodys.put("sign", sign);
// data参数是个json格式的字符串  建议使用函数或方法去生成
bodys.put("data", "{"customer_name":"快宝网络","customer_password":"123456*","customer_id" : "","shipper_type":"sto","site_flag":"上海快宝网点"}");try {/*** 重要提示如下:* HttpUtils请从* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/src/main/java/com/aliyun/api/gateway/demo/util/HttpUtils.java* 下载** 相应的依赖请参照* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/pom.xml*/HttpResponse response = HttpUtils.doPost(host, path, requestMethod, headers, querys, bodys);System.out.println(response.toString());//获取response的bodySystem.out.println(EntityUtils.toString(response.getEntity()));} catch (Exception e) {e.printStackTrace();}
}// 计算md5public static String getMD5(String plainText, int length) {try {MessageDigest md = MessageDigest.getInstance("MD5");//获取MD5实例md.update(plainText.getBytes());//此处传入要加密的byte类型值byte[] digest = md.digest();//此处得到的是md5加密后的byte类型值/*下边的运算就是自己添加的一些二次小加密，记住这个千万不能弄错乱，否则在解密的时候，你会发现值不对的（举例：在注册的时候加密方式是一种，在我们登录的时候是不是还需要加密它的密码然后和数据库的进行比对，但是最后我们发现，明明密码对啊，就是打不到预期效果，这时候你就要想一下，你是否有改动前后的加密方式）   */int i;StringBuilder sb = new StringBuilder();for (int offset = 0; offset < digest.length; offset++) {i = digest[offset];if (i < 0)i += 256;if (i < 16)sb.append(0);sb.append(Integer.toHexString(i));//通过Integer.toHexString方法把值变为16进制}return sb.toString().substring(0, length);//从下标0开始，length目的是截取多少长度的值} catch (NoSuchAlgorithmException e) {e.printStackTrace();return null;}}
}

响应示例

成功响应示例

JSON示例

{"code":

int0

"msg":

string"success"

"data":{"result":{"count":

int281

"shipper_type":

string"STO"

"remark":

string""

"pay_type":

string""

"add_service":[]

}"custom_value":

string""

"reason":

string"ok"

"unique_no":

string"e8567232b7def59a7b852dbf760c535be42e63de"

}}

异常响应示例

JSON示例

{"code":

string"错误代码"

"msg":

string"错误信息"

"data":{}

}

错误代码

暂无数据

应用场景

接口名称

公共参数

请求参数

响应参数

请求示例

响应示例

错误代码

首页

解决方案

ERP系统物流模块
电商平台解决方案
上门取件解决方案

产品

物流轨迹
地址库
电子面单
云打印

API文档

API文档
API工具

关于我们

公司简介
法律声明

使用微信或企业微信扫码加入群聊

友情链接：申通快递中通快递顺丰速运中国邮政速递物流韵达快递