文档中心 > API类目 > 工具类API

koubei.member.data.oauth.query (口碑业务授权令牌查询)

口碑业务授权第三方反查授权业务数据。服务商或商家在口碑平台跳转到ISV页面,此时ISV需要知道当前操作者是谁、当前服务商操作的商家是哪个等信息。同时该用户在ISV上的操作如需调用口碑接口时,部分接口需要带上这个code以确认当前操作人及权限校验。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.member.data.oauth.query
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
auth_type String 必须 16 授权业务类型,目前统一只有pay_member pay_member
code String 必须 32 授权码,用于换取授权信息如操作人id等.获取方式:跳转isv地址中会带有此code参数。auth_code一次有效,auth_code有效期为3分钟到24小时(开放平台规则会根据具体的业务场景动态调整auth_code的有效期,但是不会低于3分钟,同时也不会超过24小时),超过有效期的auth_code即使未使用也将无法使用。用户的每次授权动作都会生成一个新的auth_code。 4b203fe6c11548bcabd8da5bb087a83b
ext_info String 可选 512 扩展参数,目前保留未用,开发者请忽略此参数 {"key":"value"}

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
operator_id String 必填 28 操作人id 2088102150477652
operator_type String 必填 16 操作人身份,PROVIDER:服务商,PROVIDER_STAFF:服务商员工,MER:商户,MER_STAFF:商户员工,SALES:阿里销售小二 PROVIDER
operator_partner_id String 选填 28 商户id 2088102150477652
ext_info String 选填 512 扩展信息, 目前保留未用 {"key":"value"}

请求示例

  • 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");
KoubeiMemberDataOauthQueryRequest request = new KoubeiMemberDataOauthQueryRequest();
request.setBizContent("{" +
"\"auth_type\":\"pay_member\"," +
"\"code\":\"4b203fe6c11548bcabd8da5bb087a83b\"," +
"\"ext_info\":\"{\\\"key\\\":\\\"value\\\"}\"" +
"}");
KoubeiMemberDataOauthQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"koubei_member_data_oauth_query_response":{
		"msg":"Success",
		"code":"10000",
		"operator_id":"2088102150477652",
		"operator_partner_id":"2088102150477652",
		"ext_info":"{\"key\":\"value\"}",
		"operator_type":"PROVIDER"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查输入参数
AUTH_CODE_NOT_EXIST 授权码不存在 检查输入参数code是否正确
AUTH_CODE_EXPIRES 授权码过期 重新让用户授权
ACCESS_NOT_ALLOWED 无权访问 检查授权码code输入是否正确
SYSTEM_ERROR 系统繁忙 稍后重试

公共错误码

返回
顶部