阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
verify_token	String	必须	8fcfd86ebc4a47adbea10245a26277c2	token
client_info	RpClientInfo	必须		客户端信息，如果是服务端接入，里面的参数可为空
└ os_version String 可选 5.0.1 os版本号 └ total_memory String 可选 120 总内存 └ available_memory String 可选 11 剩余内存 └ umid_token String 可选 324sad umid_token └ wua_token String 可选 12abasf12e 无线端用于风控的token └ ip String 可选 1.11.2.23 ip地址 └ timestamp_info String 可选 124124 时间戳 └ mobile_model String 可选 4.1 手机型号 └ wua String 可选 {'key':'value'} 无线端用于风控的wua数据 └ app_name String 可选 MoneyShield 应用名 └ liveness_sdk_name String 可选 11 活体sdk名字 └ extend_map String 可选 {} xxx └ rp_sdk_name String 可选 xxx 认证SDK名字 └ app_version String 可选 1.0.0 应用版本 └ session_id String 可选 2341 session_id └ manufacturer String 可选 a 制造商 └ cpu_arch String 可选 xxx 架构 └ rp_sdk_version String 可选 1.0 认证SDK版本号 └ liveness_sdk_version String 可选 1.1 活体sdk版本 └ os_name String 可选 ios 客户端OS名称 └ device_id String 可选 1.02 原始设备号 └ app_key_info String 可选 12ssaf appKey └ client_type String 可选 pc 客户端类别
extra_data	Json	可选	{'a':'a'}	扩展信息

名称	类型	示例值	描述
data	RpStartResult	{}	返回结果信息
└ extra_info String {} 辅助信息 └ source String MoneyShield 客户端来源 └ biz String POS 业务点 steps RpStepItem [] [] 认证步骤对象 └ json_assist String xxx jsonAssist properties RpStepProperty [] [] 步骤信息 └ is_optional Boolean true 是否可选 property RpProperty {} 材料类别 └ name String name name └ code Number code code step_type RpStepType {} stepType └ desc String desc desc └ name String name name └ code Number 12 code upload_token StsUploadToken {} 上传的token信息 └ path String path path └ end_point String end_point end_point └ bucket_name String bucket_name bucket_name └ token String CAES7wMIARKAAZcd18o1xkgBsxcNhZverTp9TEH4QphjjPXWuthf9blMKuDfwYIViYCo9 token └ expiration String 2016-04-28T08:17:03Z 过期时间 └ access_key_secret String TLJwGC7tMqvmypsJuVMS6WHEpoYVb1Dee6RbD3ppHWW secret └ access_key_id String STS.Jw9CjnS7zZfy2XMJ4saBKgyng id

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaSecurityJaqRpStartRequest req = new AlibabaSecurityJaqRpStartRequest();
req.setVerifyToken("8fcfd86ebc4a47adbea10245a26277c2");
AlibabaSecurityJaqRpStartRequest.RpClientInfo obj1 = new AlibabaSecurityJaqRpStartRequest.RpClientInfo();
obj1.setOsVersion("5.0.1");
obj1.setTotalMemory("120");
obj1.setAvailableMemory("11");
obj1.setUmidToken("324sad");
obj1.setWuaToken("12abasf12e");
obj1.setIp("1.11.2.23");
obj1.setTimestampInfo("124124");
obj1.setMobileModel("4.1");
obj1.setWua("{'key':'value'}");
obj1.setAppName("MoneyShield");
obj1.setLivenessSdkName("11");
obj1.setExtendMap("{}");
obj1.setRpSdkName("xxx");
obj1.setAppVersion("1.0.0");
obj1.setSessionId("2341");
obj1.setManufacturer("a");
obj1.setCpuArch("xxx");
obj1.setRpSdkVersion("1.0");
obj1.setLivenessSdkVersion("1.1");
obj1.setOsName("ios");
obj1.setDeviceId("1.02");
obj1.setAppKeyInfo("12ssaf");
obj1.setClientType("pc");
req.setClientInfo(obj1);
req.setExtraDataString("{'a':'a'}");
AlibabaSecurityJaqRpStartResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaSecurityJaqRpStartRequest req = new AlibabaSecurityJaqRpStartRequest();
req.VerifyToken = "8fcfd86ebc4a47adbea10245a26277c2";
AlibabaSecurityJaqRpStartRequest.RpClientInfoDomain obj1 = new AlibabaSecurityJaqRpStartRequest.RpClientInfoDomain();
obj1.OsVersion = "5.0.1";
obj1.TotalMemory = "120";
obj1.AvailableMemory = "11";
obj1.UmidToken = "324sad";
obj1.WuaToken = "12abasf12e";
obj1.Ip = "1.11.2.23";
obj1.TimestampInfo = "124124";
obj1.MobileModel = "4.1";
obj1.Wua = "{'key':'value'}";
obj1.AppName = "MoneyShield";
obj1.LivenessSdkName = "11";
obj1.ExtendMap = "{}";
obj1.RpSdkName = "xxx";
obj1.AppVersion = "1.0.0";
obj1.SessionId = "2341";
obj1.Manufacturer = "a";
obj1.CpuArch = "xxx";
obj1.RpSdkVersion = "1.0";
obj1.LivenessSdkVersion = "1.1";
obj1.OsName = "ios";
obj1.DeviceId = "1.02";
obj1.AppKeyInfo = "12ssaf";
obj1.ClientType = "pc";
req.ClientInfo_ = obj1;
req.ExtraData = "{'a':'a'}";
AlibabaSecurityJaqRpStartResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaSecurityJaqRpStartRequest;
$req->setVerifyToken("8fcfd86ebc4a47adbea10245a26277c2");
$client_info = new RpClientInfo;
$client_info->os_version="5.0.1";
$client_info->total_memory="120";
$client_info->available_memory="11";
$client_info->umid_token="324sad";
$client_info->wua_token="12abasf12e";
$client_info->ip="1.11.2.23";
$client_info->timestamp_info="124124";
$client_info->mobile_model="4.1";
$client_info->wua="{'key':'value'}";
$client_info->app_name="MoneyShield";
$client_info->liveness_sdk_name="11";
$client_info->extend_map="{}";
$client_info->rp_sdk_name="xxx";
$client_info->app_version="1.0.0";
$client_info->session_id="2341";
$client_info->manufacturer="a";
$client_info->cpu_arch="xxx";
$client_info->rp_sdk_version="1.0";
$client_info->liveness_sdk_version="1.1";
$client_info->os_name="ios";
$client_info->device_id="1.02";
$client_info->app_key_info="12ssaf";
$client_info->client_type="pc";
$req->setClientInfo(json_encode($client_info));
$req->setExtraData("{'a':'a'}");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.security.jaq.rp.start' \
-d 'partner_id=apidoc' \
-d 'sign=82356BA6E1F61F54A05778E553886B62' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-04-26+21%3A02%3A41' \
-d 'v=2.0' \
-d 'client_info=null' \
-d 'extra_data=%7B%27a%27%3A%27a%27%7D' \
-d 'verify_token=8fcfd86ebc4a47adbea10245a26277c2'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaSecurityJaqRpStartRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.verify_token="8fcfd86ebc4a47adbea10245a26277c2"
req.client_info=""
req.extra_data="{'a':'a'}"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.security.jaq.rp.start");
add_param(pRequest,"verify_token","8fcfd86ebc4a47adbea10245a26277c2");
add_param(pRequest,"client_info","数据结构JSON示例");
add_param(pRequest,"extra_data","{'a':'a'}");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.security.jaq.rp.start', {
	'verify_token':'8fcfd86ebc4a47adbea10245a26277c2',
	'client_info':'数据结构JSON示例',
	'extra_data':'{'a':'a'}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_security_jaq_rp_start_response>
    <data>
        <extra_info>{}</extra_info>
        <source>MoneyShield</source>
        <biz>POS</biz>
        <steps>
            <rp_step_item>
                <json_assist>xxx</json_assist>
                <properties>
                    <rp_step_property>
                        <is_optional>true</is_optional>
                        <property>
                            <name>name</name>
                            <code>code</code>
                        </property>
                    </rp_step_property>
                </properties>
                <step_type>
                    <desc>desc</desc>
                    <name>name</name>
                    <code>12</code>
                </step_type>
            </rp_step_item>
        </steps>
        <upload_token>
            <path>path</path>
            <end_point>end_point</end_point>
            <bucket_name>bucket_name</bucket_name>
            <token>CAES7wMIARKAAZcd18o1xkgBsxcNhZverTp9TEH4QphjjPXWuthf9blMKuDfwYIViYCo9</token>
            <expiration>2016-04-28T08:17:03Z</expiration>
            <access_key_secret>TLJwGC7tMqvmypsJuVMS6WHEpoYVb1Dee6RbD3ppHWW</access_key_secret>
            <access_key_id>STS.Jw9CjnS7zZfy2XMJ4saBKgyng</access_key_id>
        </upload_token>
    </data>
</alibaba_security_jaq_rp_start_response>

{
    "alibaba_security_jaq_rp_start_response":{
        "data":{
            "extra_info":"{}",
            "source":"MoneyShield",
            "biz":"POS",
            "steps":{
                "rp_step_item":[
                    {
                        "json_assist":"xxx",
                        "properties":{
                            "rp_step_property":[
                                {
                                    "is_optional":true,
                                    "property":{
                                        "name":"name",
                                        "code":code
                                    }
                                }
                            ]
                        },
                        "step_type":{
                            "desc":"desc",
                            "name":"name",
                            "code":12
                        }
                    }
                ]
            },
            "upload_token":{
                "path":"path",
                "end_point":"end_point",
                "bucket_name":"bucket_name",
                "token":"CAES7wMIARKAAZcd18o1xkgBsxcNhZverTp9TEH4QphjjPXWuthf9blMKuDfwYIViYCo9",
                "expiration":"2016-04-28T08:17:03Z",
                "access_key_secret":"TLJwGC7tMqvmypsJuVMS6WHEpoYVb1Dee6RbD3ppHWW",
                "access_key_id":"STS.Jw9CjnS7zZfy2XMJ4saBKgyng"
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案
isp.server-error	服务端错误	稍后重试
isv.param-error	请求参数错误	检测入参

API测试工具错误码查询工具 SDK下载

聚安全API

alibaba.security.jaq.rp.start (聚安全实人认证开始)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈