文档

公共参数

更新时间:

本文介绍调用风险识别API时使用的公共请求参数和公共返回参数。

公共请求参数

风险识别API接口的入参参数包含公共请求参数和具体服务事件参数,公共请求参数是指每一个接口都需要使用到的参数,以下表格是公共请求参数的详细介绍。

名称

类型

是否必须

描述

Format

String

返回消息的格式。取值: 

  • JSON (默认值)

  • XML

Version

String

API版本号,使用YYYY-MM-DD日期格式,本版本对应为2019-05-21。

AccessKeyId

String

阿里云颁发给用户的访问服务所用的密钥ID。

Signature

String

签名结果串,关于签名的计算方法,请参见签名机制调用方式第2.0节。

SignatureMethod

String

签名方式,目前支持HMAC-SHA1。

Timestamp

String

请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:yyyy-MM-ddTHH:mm:ssZ。例如,北京时间2019年8月22日09点44分35秒表示为2019-08-22T01:44:35Z。

SignatureVersion

String

签名算法版本,取值为1.0。

SignatureNonce

String

唯一随机数,用于防止网络重放攻击。不同请求要使用不同的随机数值。

Action

String

值必须是ExecuteRequest。

Service

String

阿里云云盾颁发的服务code,不可随意设置。以下是各服务对应的code列表: 

  • 注册风险识别-增强版服务:account_abuse_pro

  • 注册风险识别服务:account_abuse

  • 营销风险识别-增强版服务:coupon_abuse_pro

  • 营销风险识别服务:coupon_abuse

  • 登录风险识别-增强版服务:account_takeover_pro

  • 登录风险识别服务:account_takeover

  • 流量推广反作弊服务:Ad_fraud_detection

  • 流量推广反作弊-增强版服务:Ad_fraud_detection_pro

  • 设备风险识别服务:device_risk

  • 设备风险识别-增强版服务:device_risk_pro

  • 风险情报服务:risk_intelligence

  • 邮箱画像服务:email_risk

  • 地址评分服务:address_validation

  • 蚁盾.营销保护服务:yd_coupon_abuse

  • 蚁盾.注册保护服务:yd_account_abuse

  • IP风险画像服务:risk_intelligence_ip

ServiceParameters

String

服务参数列表的JSON格式为{"accountId":10123**** …该事件下其他请求参数}。以下是具体字段和参数值格式的链接列表: 

以下是注册风险识别-增强版服务的请求示例: 

    https://saf.cn-shanghai.aliyuncs.com/
    ?Format=JSON
    &Version=2020-07-06
    &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D 
    &SignatureMethod=Hmac-SHA1
    &SignatureNonce=15215528852396
    &SignatureVersion=1.0
    &Action=ExecuteRequest
    &AccessKeyId=123****saf 
    &Timestamp=2018-06-01T12:00:00Z
    &Service=account_abuse_pro
    &ServiceParameters={"accountId":1012**** …该事件下其他请求参数,详见具体服务的事件参数}
                

公共返回参数

您发送的每次接口调用请求,无论成功与否,系统都会返回唯一识别码RequestId。其他返回参数包含score(分数)、tags(标签)、extend(自定义返回参数),服务不同返回的参数不同,详见具体服务对应的文档。

以下是注册风险识别-增强版服务返回参数的JSON示例: 

{
    //service:account_abuse_pro

    "Data": {
        "score": 85.92, //风险得分,取值范围:0~100,double格式
        "tags": "rm0101" //风险标签,string格式
    },
    "Message": "OK",
    "Code": 200, //200表示请求成功
    "RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
}              
说明

本文中的返回示例为了便于阅读,做了格式化处理,实际返回结果没有进行换行、缩进等格式化处理。

以下是邮箱画像服务返回参数的JSON示例: 

{
    "Data": {
        "tags": "temp_email,gibberish_email" //string格式
    },
    "Message": "OK",
    "Code": 200, //200表示请求成功
    "RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
}    

错误码

Code

含义描述

200

请求成功。

400

ServiceParameters(事件参数)不合法。

402

QPS超过已购规格,限流。

403

权限不足,服务未开通或已到期。

404

Service(服务参数)不合法。

500

内部服务器错误。

  • 本页导读 (0)
文档反馈