文档中心 > API类目 > 开放生态API

koubei.craftsman.data.provider.batchquery (批量查询手艺人信息接口)

如果存在手艺人id,忽略其它参数,根据手艺人id查询; 如果知道手艺人外部id,没有手艺人id,根据手艺人外部id查询; 如果不知道具体的手艺人id,手艺人外部id,那么就传入shopId,把门店下的所有手艺人都查询出来;

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.craftsman.data.provider.batchquery
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
craftsman_ids String [] 可选 64 手艺人id (如果传入craftsman_ids,会忽略其他参数:注意,不能与shop_id同时为空),以数组方式传值 210937
out_craftsman_ids String [] 可选 64 手艺人外部id(如果没有传craftsman_ids,传了craftsman_external_ids,会忽略其他参数,注意,不能与shop_id 同时为空) 20161227
shop_id String 可选 64 口碑门店id(不能与craftsman_ids和out_craftsman_ids同时为空) 2015123000077000000002414370
recommend Boolean 可选 16 是否推荐 (true 返回在c端展示的手艺人,false 返回c端隐藏的手艺人,不传表示不过滤) true
page_no String 可选 4 页码,大于0,最大为int的最大值 1
page_size String 可选 4 每页的条数,大于0,最大不超过100条 20
qr_code_shop_id String 可选 64 手艺人码对应的门店,只有指定了码门店字段,才会返回手艺人码信息 2016102100077000000003441154
auth_code String 可选 64 服务商、服务商员工、商户、商户员工等口碑角色操作时必填,对应为 koubei.member.data.oauth.query 中的 auth_code,默认有效期24小时;ISV自身角色操作的时候,无需传该参数 6a8713a414da4a2dafdb7c24e597TX80

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
craftsmans CraftsmanOpenModel [] 必填 - craftsmans:手艺人信息
  • └ craftsman_id
  • String
  • 必填
  • 64
  • 口碑手艺人id
  • 210937
  • └ name
  • String
  • 必填
  • 40
  • 手艺人真实姓名,isv生成,由手艺人用户在isv系统填写,展示给商户看。上限40个字。
  • 张三
  • └ account
  • String
  • 必填
  • 12
  • 手艺人账户名,仅支持小写字母和数字。上限12个小写字母或者数字。举例,若商户在口碑商家的登录账号为 testaop01@alipay.com,手艺人账号名为zhangsan,则手艺人登录口碑商家的账号名为 testaop01@alipay.com#zhangsan,获取登录密码需要扫商户app的员工激活码。从口碑商家app的员工管理进入员工详情页获取登录密码。
  • zhangsan
  • └ nick_name
  • String
  • 必填
  • 16
  • 昵称,上限16字,手艺人个人主页名称,展示给消费者看。
  • 阿诺,KK.
  • └ avatar
  • String
  • 选填
  • 64
  • 手艺人头像,在商家端手艺人管理和用户端手艺人个人简介中展示手艺人头像,两种格式1.图片全路径,http或https开头 2.图片id (通过 alipay.offline.material.image.upload 接口上传图片获取的资源id),上限最大5M,支持bmp,png,jpeg,jpg,gif格式的图片。
  • TxFyuus3RUW8wAeYfubM7gAAACMAAQED/http://tfs.alipayobjects.com/images/partner/xxxxxxxxxxxxxxxxx_160X160
  • └ title
  • String
  • 选填
  • 10
  • 头衔,手艺人在店内的职称。上限10个字。
  • 高级造型师
  • └ tel_num
  • String
  • 选填
  • 16
  • 手艺人的手机号,在商家端和用户端展示,不支持座机
  • 18018801880
  • └ careers
  • String []
  • 选填
  • 1
  • 职业。目前只能传支持一个。枚举类型目前有19种,发型师、美甲师、美容师、美睫师、纹绣师、纹身师、摄影师、教练、教师、化妆师、司仪、摄像师、按摩技师、足疗技师、灸疗师、理疗师、修脚师、采耳师、其他。
  • 发型师
  • └ career_begin
  • Date
  • 选填
  • 10
  • 从业起始年月
  • 2016-12-12
  • └ specialities
  • String []
  • 选填
  • 6
  • 描述手艺人擅长的技术(如烫染、二分式剪法、足疗、中医推拿、刮痧、火疗、拔罐、婚纱、儿童、写真...)。最多6个标签,每个标签字段上限10个字。
  • 烫发,瑜伽,有氧
  • └ introduction
  • String
  • 选填
  • 300
  • 手艺人简介,上限300字。
  • 中国好声音御用造型师,2010年获得沙宣美发大赛一等奖,得过沙宣美发学校的证书。
  • └ out_craftsman_id
  • String
  • 选填
  • 64
  • 外部手艺人id,由ISV生成,isv的appId + 外部手艺人id全局唯一
  • 20161227
  • └ status
  • String
  • 选填
  • 16
  • 手艺人状态,EFFECTIVE和INVALID,生效和失效。失效状态一般用于手艺人已离职 或者 手艺人发布不实信息导致用户投诉被平台处罚。
  • EFFECTIVE
  • └ user_id
  • String
  • 选填
  • 32
  • 支付宝账户uid
  • 2088101164264830
  • shop_relations
  • CraftsmanShopRelationOpenModel []
  • 必填
  • 100
  • 手艺人所属门店
  • └ shop_id
  • String
  • 必填
  • 64
  • 口碑门店ID,可通过门店摘要信息批量查询接口 alipay.offline.market.shop.summary.batchquery获取。
  • 2016102100077000000003441154
  • └ recommend_weight
  • Number
  • 必填
  • 11
  • 推荐权重。整数。小于等于0表示不在口碑店铺页展示 大于0表示在口碑店铺页展示, 值越大,排序越靠前。
  • 0
  • assessment
  • CraftsmanAssessment
  • 必填
  • 64
  • 手艺人评分信息
  • └ total_no
  • Number
  • 必填
  • 12
  • 单个手艺人的评价总条数。
  • 999
  • └ total_score
  • Number
  • 必填
  • 5
  • 单个手艺人的总评分的均分
  • 5.0
  • sub_assessments
  • CraftsmanSubAssessment []
  • 选填
  • 64
  • 子评分项
  • └ title
  • String
  • 必填
  • 16
  • 子评分项名
  • 服务态度
  • └ score
  • Number
  • 必填
  • 11
  • 子评分
  • 4.0
  • └ qr_code
  • String
  • 选填
  • 1024
  • 收款二维码地址,手艺人收款码,每个手艺人都有一个收款二维码。该二维码收款所得的金额进入商户的账号,如果手艺人所在的门店设置了门店收款账号,则资金进入门店收款账号,如果没有设置门店收款账号,则资金进入商户与口碑开店签约的支付宝账号。
  • https://qr.alipay.com/bavh4wjlxfxxxxxxxx
  • └ operator_id
  • String
  • 必填
  • 64
  • 手艺人关联的操作员ID
  • 2088201963612200
page_size Number 必填 3 每页记录数 20
current_page_no Number 必填 9 当前页码 1
total_page_no Number 必填 9 总页码数目 3
total_craftsmans Number 必填 9 门店下共手艺人数目 50

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiCraftsmanDataProviderBatchqueryRequest request = new KoubeiCraftsmanDataProviderBatchqueryRequest();
request.setBizContent("{" +
"\"craftsman_ids\":[" +
"\"210937\"" +
"]," +
"\"out_craftsman_ids\":[" +
"\"20161227\"" +
"]," +
"\"shop_id\":\"2015123000077000000002414370\"," +
"\"recommend\":true," +
"\"page_no\":\"1\"," +
"\"page_size\":\"20\"," +
"\"qr_code_shop_id\":\"2016102100077000000003441154\"," +
"\"auth_code\":\"6a8713a414da4a2dafdb7c24e597TX80\"" +
"}");
KoubeiCraftsmanDataProviderBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_craftsman_data_provider_batchquery_response":{
		"msg":"Success",
		"code":"10000",
		"total_page_no":3,
		"current_page_no":1,
		"craftsmans":[
			{
				"out_craftsman_id":"20161227",
				"operator_id":"2088201963612200",
				"tel_num":"18018801880",
				"avatar":"TxFyuus3RUW8wAeYfubM7gAAACMAAQED/http://tfs.alipayobjects.com/images/partner/xxxxxxxxxxxxxxxxx_160X160",
				"title":"高级造型师",
				"craftsman_id":"210937",
				"careers":[
					"发型师"
				],
				"assessment":{
					"sub_assessments":[
						{
							"score":4.0,
							"title":"服务态度"
						}
					],
					"total_score":5.0,
					"total_no":999
				},
				"shop_relations":[
					{
						"shop_id":"2016102100077000000003441154",
						"recommend_weight":0
					}
				],
				"career_begin":"2016-12-12",
				"user_id":"2088101164264830",
				"nick_name":"阿诺,KK.",
				"name":"张三",
				"qr_code":"https://qr.alipay.com/bavh4wjlxfxxxxxxxx",
				"account":"zhangsan",
				"specialities":[
					"烫发",
					"瑜伽",
					"有氧"
				],
				"introduction":"中国好声音御用造型师,2010年获得沙宣美发大赛一等奖,得过沙宣美发学校的证书。",
				"status":"EFFECTIVE"
			}
		],
		"page_size":20,
		"total_craftsmans":50
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_craftsman_data_provider_batchquery_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 请按照错误码描述修改校验不通过的参数
CRAFTSMAN_SHOP_NOT_BELONGS_PID 手艺人关联门店不属于该商户 通过alipay.offline.market.shop.batchquery 或alipay.offline.market.shop.summary.batchquery查询门店对应的pid
CRAFTSMAN_NOT_BELONGS_TO_PID 手艺人不属于该授权商户 请使用手艺人归属的商户授权信息访问该接口
SYSTEM_ERROR 系统繁忙 请重试或准备好外部手艺人id、appid等信息给技术支持排查,参考链接https://support.open.alipay.com/alipay/support/index.htm

公共错误码

返回
顶部