调用方式

本文介绍如何对接风险识别API服务。风险识别产品同时支持SDK方式调用、和原生HTTPS方式调用。但原生HTTPS协议方式需要用户自己封装协议、加签解签,复杂度较高,因此我们推荐客户使用SDK方式,简单便捷。

1. SDK调用方式介绍

通过使用阿里云风险识别SDK,调用方无需关注签名验证以及Body格式构建等繁琐的事情,推荐您使用风险识别SDK。目前支持JAVA、Python、PHP、C#、Golang、Node.js、Ruby共7种SDK。

1.1. JAVA SDK

单击此处下载JAVA SDK源码。

JAVA SDK的环境准备、安装使用请参见阿里云SDK开发指南

JAVA Maven依赖:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-saf</artifactId>
    <version>1.0.2</version>
</dependency>

JAVA Maven推荐依赖仲裁:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <optional>true</optional>
    <version>4.5.1</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.60</version>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.2</version>
</dependency>
<dependency>        
    <groupId>org.apache.httpcomponents</groupId>        
    <artifactId>httpclient</artifactId>        
    <version>4.5.3</version>    
</dependency>    
<dependency>       
    <groupId>io.opentracing</groupId>       
    <artifactId>opentracing-util</artifactId>        
    <version>0.31.0</version>    
</dependency>

单击此处查看JAVA用例。

单击地址1地址2访问JAVA Maven仓库。

1.2. Python SDK

单击此处下载Python SDK源码。

Python SDK的环境准备、安装使用请参见阿里云SDK开发指南

  1. 安装SDK核心库。

    • 如果您使用Python 2.x,执行以下命令,安装阿里云SDK核心库:

      pip install aliyun-python-sdk-core
    • 如果您使用Python 3.x,执行以下命令,安装阿里云SDK核心库:

      pip install aliyun-python-sdk-core-v3
  2. 安装云产品SAF SDK。

    pip install aliyun-python-sdk-saf

Python用例:

from aliyunsdkcore import client
from aliyunsdksaf.request.v20190521 import ExecuteRequestRequest
clt = client.AcsClient('<your-access-key-id>','<your-access-key-secret>','cn-shanghai')
# 设置参数
request = ExecuteRequestRequest.ExecuteRequestRequest()
request.set_accept_format('json')
# 产品Service请参考[公共参数]文档中的Service字段描述
request.add_query_param('Service', '购买的产品Service')
request.add_query_param('ServiceParameters', '入参json字符串')
# 发起请求
response = clt.do_action_with_exception(request)
print(response)
                                

1.3. PHP SDK

单击此处下载PHP SDK源码。

PHP SDK的环境准备、安装使用请参见阿里云SDK开发指南

PHP用例:

<?php
include_once 'aliyun-openapi-php-sdk/aliyun-php-sdk-core/Config.php';
use saf\Request\V20190521 as saf;
// 初始化
$iClientProfile = DefaultProfile::getProfile("cn-shanghai", "<your-access-key-id>", "<your-access-key-secret>");
$client = new DefaultAcsClient($iClientProfile);
//设置参数
$request = new saf\ExecuteRequestRequest();
// 产品Service请参考[公共参数]文档中的Service字段描述
$request->setService('购买的产品Service');
$request->setServiceParameters('入参json字符串');
// 发起请求
$response = $client->getAcsResponse($request);
print_r("<br>");
print_r("test");
print_r("\r\n");
print_r($response);
print_r($client);
?>

1.4. C# SDK

单击此处下载C# SDK源码。

C# SDK的环境准备、安装使用请参见阿里云SDK开发指南

1.5. Golang SDK

单击此处下载Golang SDK源码。

Golang SDK的环境准备、安装使用请参见阿里云SDK开发指南

Golang用例:

package main
import (
    "fmt"
    "github.com/aliyun/alibaba-cloud-sdk-go/services/saf"
)
func main() {
    client, err := saf.NewClientWithAccessKey("cn-shanghai", "<your-access-key-id>", "<your-access-key-secret>")
    request := saf.CreateExecuteRequestRequest()
    endpoints.AddEndpointMapping("cn-shanghai", "saf", "saf.cn-shanghai.aliyuncs.com")
    // 产品Service请参考[公共参数]文档中的Service字段描述
    request.Service = "购买的产品Service"
    request.ServiceParameters = "入参json字符串"
    request.Scheme = "https"
    response, err := client.ExecuteRequest(request)
    if err != nil {
        fmt.Print(err.Error())
    }
    fmt.Printf("response code is %#v\n", response.Code)
    fmt.Printf("response date is %#v\n", response.Data)
    fmt.Printf("response message is %#v\n", response.Message)
    fmt.Printf("response requestId is %#v\n", response.RequestId)
}

1.6. Node.js SDK

单击此处下载Node.js SDK源码。

Node.js SDK的环境准备、安装使用请参见阿里云SDK开发指南

执行以下命令安装@alicloud/pop-core模块。命令中的--save会将模块写入应用的package.json文件中,作为依赖模块。

$ npm install @alicloud/pop-core --save

Node.js用例:

const Core = require('@alicloud/pop-core');
var client = new Core({
  accessKeyId: '<your-access-key-id>',
  accessKeySecret: '<your-access-key-secret>',
  endpoint: 'https://saf.cn-shanghai.aliyuncs.com',
  apiVersion: '2019-01-28'
});
var params = {
  "RegionId": "cn-shanghai",
  // 产品Service请参考[公共参数]文档中的Service字段描述
  "Service": "购买的产品Service",
  "ServiceParameters": "入参json字符串"
}
var requestOption = {
  method: 'POST'
};
client.request('ExecuteRequest', params, requestOption).then((result) => {
  console.log(JSON.stringify(result));
}, (ex) => {
  console.log(ex);
})

1.7. Ruby SDK

单击此处下载Ruby SDK源码。

Ruby SDK的环境准备、安装使用请参见阿里云SDK开发指南

执行以下命令安装 Alibaba Cloud Core SDK for Ruby:

$ gem install aliyunsdkcore

Ruby用例:

require 'aliyunsdkcore'
client = RPCClient.new(
  access_key_id:     '<your-access-key-id>',
  access_key_secret: '<your-access-key-secret>',
  endpoint: 'https://saf.cn-shanghai.aliyuncs.com',
  api_version: '2019-01-28'
)
response = client.request(
  action: 'ExecuteRequest',
  params: {
    "RegionId": "cn-shanghai",
    # 产品Service请参考[公共参数]文档中的Service字段描述
    "Service": "购买的产品Service",
    "ServiceParameters": "入参json字符串"
  },
  opts: {
    method: 'POST'
  }
)
print response

2. HTTPS原生调用介绍

风险识别API服务也支持HTTPS原生调用,原生方式需要用户自行封装加解签、拼装请求(URL、Body、header、parameters)。

通常必须使用HTTPS原生方式调用的仅有两种情形,如非下述两种特殊场景,建议使用SDK方式调用。

  1. 直接在App中使用,对客户端大小有极致要求;

  2. 对个别的依赖lib包有指定,不方便升级。

2.1. 基本信息

服务请求地址:https://saf.cn-shanghai.aliyuncs.com

协议:HTTPS

HttpMethod: POST

2.2. 签名方式

风险识别服务会对每个访问的请求进行身份验证,因此,需要在请求中包含签名(Signature)信息。风险识别服务通过使用Access Key ID和Access Key Secret进行对称加密的方法来验证请求的发送者身份。Access Key ID和Access Key Secret由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中Access Key ID用于标识访问者身份;Access Key Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。

用户在访问时,按照下面的方法对请求进行签名处理:

  1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)

    a. 按照参数名称的字典顺序对请求中所有的请求参数(包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数,但不能包括"公共请求参数"中提到的Signature参数本身)进行排序。

    b. 对相关请求参数的名称和值进行编码。名称和值要使用UTF-8字符集进行URL编码,URL编码的编码规则是:

     i.对于字符A-Z、a-z、0-9以及字符"-"、"_"、"."、"~"不编码;
     ii. 对于其它字符编码成"%XY"的格式,其中XY是字符对应ASCII码的16进制表示。比如英文的双引号(")对应的编码就是%22
     iii.对于扩展的UTF-8字符,编码成"%XY%ZA…"的格式;
     iv. 需要说明的是英文空格( )要被编码是%20,而不是加号(+)。
         

    注: 一般支持URL编码的库(比如Java中的java.net.URLEncoder)都是按照"application/x-www-form-urlencoded"的MIME类型的规则进行编码的。实现时可以直接使用这类方式进行编码,把编码后的字符串中加号(+)替换成%20、星号(*)替换成%2A、%7E替换回波浪号(~),即可得到上述规则描述的编码字符串。

    c. 对编码后的参数名称和值使用英文等号(=)进行连接。

    d. 再把英文等号连接得到字符串按参数名称的字典顺序依次使用&符号连接,即得到规范化请求字符串。

  2. 使用上一步(步骤1)构造的规范化字符串按照下面的规则构造用于计算签名的字符串:

     StringToSign=
     HTTPMethod + "&" +
     percentEncode("/") + "&" +
     percentEncode(CanonicalizedQueryString)
         

    其中HTTPMethod是提交请求用的HTTP方法,比如POST。

    percentEncode("/")是按照1.b中描述的URL编码规则对字符"/"进行编码得到的值,即"%2F"。

    percentEncode(CanonicalQueryString)是对第1步中构造的规范化请求字符串按1.b中描述的URL编码规则编码后得到的字符串。

  3. 按照RFC2104的定义,使用上面的用于签名的字符串计算签名HMAC值。注意:计算签名时使用的Key就是用户持有的Access Key Secret并加上一个"&"字符(ASCII:38),使用的哈希算法是SHA1。

  4. 按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature)。

  5. 将得到的签名值作为Signature参数添加到请求参数中,即完成对请求签名的过程。

    注意:得到的签名值在作为最后的请求参数值提交给风险识别服务器时,要和其他参数一样,按照RFC3986的规则进行URL编码)。