接口介绍
本接口用于第三方查询平台账号下的服务商列表数据,高级服务商账号才能够调用此接口。
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.agent.list |
是 |
app |
String(32) |
接入商标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:2.0 |
是 |
sign_type |
String(32) |
签名类型 MD5、RSA,默认MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名、RSA256签名 |
是 |
业务参数
没有业务参数
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
success |
result |
boolean |
标识这次请求是否成功 |
|
error_code |
result |
String(64) |
错误码 |
|
error_msg |
result |
String(16) |
错误码的详细说明 |
|
request_id |
data |
String(64) |
请求报文ID |
|
request_time |
data |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
数据返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
list |
data |
String |
服务商列表字符串 |
返回的列表字符串是经过Base64处理过的,使用前请自行解码 |
服务商信息描述
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
agent_code |
list |
String |
服务商编码 |
|
agent_name |
list |
String |
服务商名称 |
|
province_code |
list |
String |
省份编码 |
|
city_code |
list |
String |
城市编码 |
|
area_code |
list |
String |
地区编码 |
|
prov_city_area |
list |
String |
省份城市地区文字拼接,如:浙江省 杭州市 西湖区 |
|
ext_agent_code |
list |
String |
外部服务商编码 |
|
ext_agent_name |
list |
String |
外部服务商名称 |
返回值举例
{
"data": {
"list": "W3siYWdlbnRfY29kZSI6Ik4wODMxNDMiLCJhZ2VudF9uYW1lIjoi5ZC05Lya6IqsIiwiYXJlYV9jb2RlIjpudWxsLCJjaXR5X2NvZGUiOm51bGwsImV4dF9hZ2VudF9jb2RlIjoiR1gxMDI1IiwiZXh0X2FnZW50X25hbWUiOiLlkLTkvJroiqwiLCJwcm92X2NpdHlfYXJlYSI6bnVsbCwicHJvdmluY2VfY29kZSI6bnVsbH0seyJhZ2VudF9jb2RlIjoiTjA4MzE0MiIsImFnZW50X25hbWUiOiLlvKDlt40iLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6bnVsbCwiZXh0X2FnZW50X2NvZGUiOiJMTjEwMDEiLCJleHRfYWdlbnRfbmFtZSI6IuW8oOW3jSIsInByb3ZfY2l0eV9hcmVhIjpudWxsLCJwcm92aW5jZV9jb2RlIjpudWxsfSx7ImFnZW50X2NvZGUiOiJOMDgzMTQxIiwiYWdlbnRfbmFtZSI6Iui1teiLsSIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjpudWxsLCJleHRfYWdlbnRfY29kZSI6IlNYMTAxMyIsImV4dF9hZ2VudF9uYW1lIjoi6LW16IuxIiwicHJvdl9jaXR5X2FyZWEiOm51bGwsInByb3ZpbmNlX2NvZGUiOm51bGx9LHsiYWdlbnRfY29kZSI6Ik4wODMxMzkiLCJhZ2VudF9uYW1lIjoi546L57qi5qKFIiwiYXJlYV9jb2RlIjpudWxsLCJjaXR5X2NvZGUiOm51bGwsImV4dF9hZ2VudF9jb2RlIjoibHQxNTYzODAwNjk2MSIsImV4dF9hZ2VudF9uYW1lIjoi546L57qi5qKFIiwicHJvdl9jaXR5X2FyZWEiOm51bGwsInByb3ZpbmNlX2NvZGUiOm51bGx9LHsiYWdlbnRfY29kZSI6Ik4wODMxNDAiLCJhZ2VudF9uYW1lIjoi572X57qi5rGfIiwiYXJlYV9jb2RlIjoiNTIwMzI0IiwiY2l0eV9jb2RlIjoiNTIwMzAwIiwiZXh0X2FnZW50X2NvZGUiOiJTRDYxMTg5MCIsImV4dF9hZ2VudF9uYW1lIjoi572X57qi5rGfIiwicHJvdl9jaXR5X2FyZWEiOiLotLXlt57nnIEg6YG15LmJ5biCIOato+WuieWOvyIsInByb3ZpbmNlX2NvZGUiOiI1MjAwMDAifSx7ImFnZW50X2NvZGUiOiJOMDgzMTM4IiwiYWdlbnRfbmFtZSI6Iue9l+e6ouaxnyIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjpudWxsLCJleHRfYWdlbnRfY29kZSI6IlNEMzYzNTAwIiwiZXh0X2FnZW50X25hbWUiOiLnvZfnuqLmsZ8iLCJwcm92X2NpdHlfYXJlYSI6bnVsbCwicHJvdmluY2VfY29kZSI6bnVsbH0seyJhZ2VudF9jb2RlIjoiTjA4MzEzNyIsImFnZW50X25hbWUiOiLpgpPlpoLmhI8iLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6bnVsbCwiZXh0X2FnZW50X2NvZGUiOiJHWjEwMTMiLCJleHRfYWdlbnRfbmFtZSI6IumCk+WmguaEjyIsInByb3ZfY2l0eV9hcmVhIjpudWxsLCJwcm92aW5jZV9jb2RlIjpudWxsfSx7ImFnZW50X2NvZGUiOiJOMDgzMTM2IiwiYWdlbnRfbmFtZSI6Ium7hOW8uiIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjpudWxsLCJleHRfYWdlbnRfY29kZSI6IkdaMTAxOCIsImV4dF9hZ2VudF9uYW1lIjoi6buE5by6IiwicHJvdl9jaXR5X2FyZWEiOm51bGwsInByb3ZpbmNlX2NvZGUiOm51bGx9LHsiYWdlbnRfY29kZSI6Ik4wODMxMzUiLCJhZ2VudF9uYW1lIjoi6buE5by6IiwiYXJlYV9jb2RlIjpudWxsLCJjaXR5X2NvZGUiOm51bGwsImV4dF9hZ2VudF9jb2RlIjoiR1oxMDE3IiwiZXh0X2FnZW50X25hbWUiOiLpu4TlvLoiLCJwcm92X2NpdHlfYXJlYSI6bnVsbCwicHJvdmluY2VfY29kZSI6bnVsbH0seyJhZ2VudF9jb2RlIjoiTjA4MzEzNCIsImFnZW50X25hbWUiOiLnqIvojLYiLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6bnVsbCwiZXh0X2FnZW50X2NvZGUiOiJHWjEwMzEiLCJleHRfYWdlbnRfbmFtZSI6Iueoi+iMtiIsInByb3ZfY2l0eV9hcmVhIjpudWxsLCJwcm92aW5jZV9jb2RlIjpudWxsfSx7ImFnZW50X2NvZGUiOiJOMDgzMTMzIiwiYWdlbnRfbmFtZSI6IuadnOWNq+WNjiIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjpudWxsLCJleHRfYWdlbnRfY29kZSI6IlNEODIxMDYyIiwiZXh0X2FnZW50X25hbWUiOiLmnZzljavljY4iLCJwcm92X2NpdHlfYXJlYSI6bnVsbCwicHJvdmluY2VfY29kZSI6bnVsbH0seyJhZ2VudF9jb2RlIjoiTjA4MzEzMiIsImFnZW50X25hbWUiOiLpu4TlvLoiLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6bnVsbCwiZXh0X2FnZW50X2NvZGUiOiJHWjEwMjQiLCJleHRfYWdlbnRfbmFtZSI6Ium7hOW8uiIsInByb3ZfY2l0eV9hcmVhIjpudWxsLCJwcm92aW5jZV9jb2RlIjpudWxsfSx7ImFnZW50X2NvZGUiOiJOMDgzMTMxIiwiYWdlbnRfbmFtZSI6Iue9l+e6ouaxnyIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjpudWxsLCJleHRfYWdlbnRfY29kZSI6IlNEOTExMzAxIiwiZXh0X2FnZW50X25hbWUiOiLnvZfnuqLmsZ8iLCJwcm92X2NpdHlfYXJlYSI6bnVsbCwicHJvdmluY2VfY29kZSI6bnVsbH0seyJhZ2VudF9jb2RlIjoiTjA4MzEzMCIsImFnZW50X25hbWUiOiLmnZzljavljY4iLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6bnVsbCwiZXh0X2FnZW50X2NvZGUiOiJTRDU2NTc5NSIsImV4dF9hZ2VudF9uYW1lIjoi5p2c5Y2r5Y2OIiwicHJvdl9jaXR5X2FyZWEiOm51bGwsInByb3ZpbmNlX2NvZGUiOm51bGx9LHsiYWdlbnRfY29kZSI6Ik4wODMxMDYiLCJhZ2VudF9uYW1lIjoiQTAwM+WVhuaItzEwMzk0OCIsImFyZWFfY29kZSI6IjM0MDMxMSIsImNpdHlfY29kZSI6IjM0MDMwMCIsImV4dF9hZ2VudF9jb2RlIjpudWxsLCJleHRfYWdlbnRfbmFtZSI6bnVsbCwicHJvdl9jaXR5X2FyZWEiOiLlronlvr3nnIEg6JqM5Z+g5biCIOa3ruS4iuWMuiIsInByb3ZpbmNlX2NvZGUiOiIzNDAwMDAifSx7ImFnZW50X2NvZGUiOiJOMTA1IiwiYWdlbnRfbmFtZSI6IkEwMDPllYbmiLcxMDMxMjYiLCJhcmVhX2NvZGUiOm51bGwsImNpdHlfY29kZSI6IjgyMDAwNSIsImV4dF9hZ2VudF9jb2RlIjpudWxsLCJleHRfYWdlbnRfbmFtZSI6bnVsbCwicHJvdl9jaXR5X2FyZWEiOiLmvrPpl6jnibnliKvooYzmlL/ljLog6aOO6aG65aCC5Yy6IiwicHJvdmluY2VfY29kZSI6IjgyMDAwMCJ9LHsiYWdlbnRfY29kZSI6Ik0xMDAxIiwiYWdlbnRfbmFtZSI6IkEwMDPllYbmiLcxMDI4MjYiLCJhcmVhX2NvZGUiOiIzNDAzMjMiLCJjaXR5X2NvZGUiOiIzNDAzMDAiLCJleHRfYWdlbnRfY29kZSI6bnVsbCwiZXh0X2FnZW50X25hbWUiOm51bGwsInByb3ZfY2l0eV9hcmVhIjoi5a6J5b6955yBIOiajOWfoOW4giDlm7rplYfljr8iLCJwcm92aW5jZV9jb2RlIjoiMzQwMDAwIn0seyJhZ2VudF9jb2RlIjoiTTEwMSIsImFnZW50X25hbWUiOiJBMDAz5ZWG5oi3MTAyMDQ5IiwiYXJlYV9jb2RlIjoiMzQwODIyIiwiY2l0eV9jb2RlIjoiMzQwODAwIiwiZXh0X2FnZW50X2NvZGUiOm51bGwsImV4dF9hZ2VudF9uYW1lIjpudWxsLCJwcm92X2NpdHlfYXJlYSI6IuWuieW+veecgSDlronluobluIIg5oCA5a6B5Y6/IiwicHJvdmluY2VfY29kZSI6IjM0MDAwMCJ9LHsiYWdlbnRfY29kZSI6Ik0xMDAiLCJhZ2VudF9uYW1lIjoiQTAwM+WVhuaItzEwMjA0OCIsImFyZWFfY29kZSI6bnVsbCwiY2l0eV9jb2RlIjoiODIwMDA1IiwiZXh0X2FnZW50X2NvZGUiOm51bGwsImV4dF9hZ2VudF9uYW1lIjpudWxsLCJwcm92X2NpdHlfYXJlYSI6Iua+s+mXqOeJueWIq+ihjOaUv+WMuiDpo47pobrloILljLoiLCJwcm92aW5jZV9jb2RlIjoiODIwMDAwIn0seyJhZ2VudF9jb2RlIjoiSDE0OCIsImFnZW50X25hbWUiOiJBMDAz5ZWG5oi3MTAyMDQ2IiwiYXJlYV9jb2RlIjoiMzQwODAzIiwiY2l0eV9jb2RlIjoiMzQwODAwIiwiZXh0X2FnZW50X2NvZGUiOm51bGwsImV4dF9hZ2VudF9uYW1lIjpudWxsLCJwcm92X2NpdHlfYXJlYSI6IuWuieW+veecgSDlronluobluIIg5aSn6KeC5Yy6IiwicHJvdmluY2VfY29kZSI6IjM0MDAwMCJ9XQ==",
"request_id": "dcf2a0b5-5a8d-4ad9-aaa9-27333aa39742",
"request_time": "20190114151645",
"response_time": "20190114151727"
},
"result": {
"success": true
},
"sign": ""
}
js demo
http://openapi.caibaopay.com/test/api/v2/agentList.htm