Interface Authentication V3

Interface authentication v3 is more secure than the other two authentications. The original two interface authentication methods can still be used, and it is recommended to use this authentication method.
Take Cloud VoD batch obtaining video list information interface as an example to illustrate the authentication method.

Request URL

Assemble the URI parameters of the specific interface behind https://api.cloudv.haplat.net

For example, the request URL to get the video list is as follows

https://api.cloudv.haplat.net/vod/videoManage/getVideoList

Request Method

Support GET and POST requests

Individual interfaces support POST requests with content-type: application/json.

Common Parameters

This authentication method uses the following fields of request parameters:

Signature (Sinature) calculation process

Algorithm overview

1, Signature=HexEncode(HMAC_SHA256(SecretKey, StringToSign ));
2, Stringtosign = Algorithm +\n+ Timestamp +\n+Hash.SHA256( CanonicalRequest )
3, CanonicalRequest =
Method +'\n'+
RequestURI +'\n'+
QueryString +'\n'+
CanonicalHeaders +'\n'+
SignedHeaders +'\n'+
HashedRequestPayload
4, HashedRequestPayload = Lowercase(HexEncode(Hash.SHA256( RequestPayload )))

1. Canonical Request (CanonicalRequest)

Splice the Canonical Request string (CanonicalRequest) in the following pseudo-code format:

CanonicalRequest =
    Method + '\n' +
    RequestURI + '\n' +
    QueryString + '\n' +
    CanonicalHeaders + '\n' +
    SignedHeaders + '\n' +
    HashedRequestPayload

According to the above rules, the CanonicalRequest string obtained in the example is as follows:

POST
/vod/videoManage/getVideoList

content-type:application/json; charset=utf-8
host:api.cloudv.haplat.net

content-type;host
641f7989f8d223af8c5049f805890fcaf2ae4a99780a01eb454cf7c9368dd1a4

2. Join the string to be signed (StringToSign)

Concatenate the string to be signed in the following format:

StringToSign =

    Algorithm + \n +

    Timestamp + \n +

    HashedCanonicalRequest

Note: Timestamp must be the current system time, and ensure that the system time and standard time are synchronized. If the difference is more than five minutes, it will fail. If it is not synchronized with the standard time for a long time, it may cause the request to fail after running for a period of time and return a signature expiration error.

According to the above rules, the string to be signed StringToSign obtained in the example is as follows:

WS3-HMAC-SHA256
1564645579
16bc1b4d4e6818f5aec2a7273cb2c3d3e4831fd61c6510222b9bec19bffac646

3. Calculate the signature (Signature)

1. Obtain the signing key, for example:

SecretKey = bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

2. Calculate the signature, the pseudo code is as follows:

Signature = HexEncode(HMAC\_SHA256(SecretKey, StringToSign))

4. Splicing Authorization

Splice Authorization in the following format:

Authorization =
    Algorithm + ' ' +
    'Credential=' + AccessKey + ', ' +
    'SignedHeaders=' + SignedHeaders + ', ' +
    'Signature=' + Signature

According to the above rules, the value obtained in the example is:

WS3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE, SignedHeaders=content-type;host, Signature=792dcb6d648a456a030c9c6683fa7bde2a31cb4c72cfeaa354da000adf7c288d

The final complete call information is as follows:

POST https://api.cloudv.haplat.net/
Authorization: WS3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE, SignedHeaders=content-type;host, Signature=792dcb6d648a456a030c9c6683fa7bde2a31cb4c72cfeaa354da000adf7c288d
Content-Type: application/json; charset=utf-8
Host: api.cloudv.haplat.net
X-WS-AccessKey: AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE
X-WS-Timestamp: 1564645579

{"videoName":"a","pageSize":"5","pageIndex":"2"}

General error code

curl example

content-type: application/json post request (recommended method)

curl -X POST https://api.cloudv.haplat.net/vod/videoManage/getVideoList 
-H "Authorization: WS3-HMAC-SHA256 Credential=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, SignedHeaders=content-type;host, Signature=471d8f86cefa4fa2f929642207b6df8fe770e82e0df328f4f68af08c8b8a8029" 
-H "Content-Type: application/json; charset=utf-8" 
-H "Host: api.cloudv.haplat.net" 
-H "X-WS-Timestamp: 1564644606" 
-H "X-WS-AccessKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" 
-d '{"videoName": "a","pageIndex":"2","pageSize":"5"}'

content-type: application/x-www-form-urlencoded post request

curl -X POST https://api.cloudv.haplat.net/vod/videoManage/getVideoList 
-H "Authorization: WS3-HMAC-SHA256 Credential=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, SignedHeaders=content-type;host, Signature=37ea1014de0c90e83e733f8d19a5d3ae993896d34450c9f8cf8df5642c81339e" 
-H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" 
-H "Host: api.cloudv.haplat.net" 
-H "X-WS-Timestamp: 1564644607" 
-H "X-WS-AccessKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" 
-d 'videoName=a&pageIndex=2&pageSize=5'

get request
Note that the Content-Type in the get request is fixed in application/x-www-form-urlencoded format.

curl -X GET https://api.cloudv.haplat.net/vod/videoManage/getVideoList?videoName=a&pageIndex=2&pageSize=5 
-H "Authorization: WS3-HMAC-SHA256 Credential=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, SignedHeaders=content-type;host,     Signature=0b489e43c5cd2e52cbe0768a68c614a4211210a6d63b18ff65cc986f18e75aac" 
-H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" 
-H "Host: api.cloudv.haplat.net" 
-H "X-WS-Timestamp: 1564644607" 
-H "X-WS-AccessKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

content-type: post request of multipart/form-data
Due to the complicated structure of the authorization parameter of the request, it needs to be generated in the code. Please refer to the following java code example.

java code example

The API connection can be used by quoting the tool class, and the until.jar package needs to be imported .

Detailed code example

import com.cnc.cloudv.util.auth.ApiAuthUtil;
import com.cnc.cloudv.util.httpclient.CloudvHttpResponse;

import java.util.HashMap;
import java.util.Map;

public class TestAuthUtil {
//通过秘钥管理获取的秘租
    private final static String ACCESS_KEY = "aaaaaaaaaaaaaaaaaaaaaaaaa";
    private final static String SECRET_KEY = "bbbbbbbbbbbbbbbbb";
//这里固定为云视频API域名
    private final static String API_HOST = "api.cloudv.haplat.net";

    public static void main(String[] args) throws Exception {
        Map<String, String> customHeaderMap = new HashMap<String, String>(2);
	//可以支持自定义头部
        customHeaderMap.put("from", "test-authentification-sdk");
		//请求接口的URI
        String requestURI = "/vod/videoManage/getVideoList";

	//application/json方式的post请求调用
        String body = "{\"videoName\": \"测\",\"pageIndex\":\"2\",\"pageSize\":\"5\",\"format\": \"json\"}";
        CloudvHttpResponse cloudvHttpResponse = ApiAuthUtil.callPostJsonBodyRequest(API_HOST, ACCESS_KEY, SECRET_KEY, requestURI, customHeaderMap, body);
        log(cloudvHttpResponse);
		
	//get请求的调用例子
        String canonicalQueryString = "videoName=" + java.net.URLEncoder.encode("测", "utf-8") + "&pageIndex=2&pageSize=5&format=json";
        cloudvHttpResponse = ApiAuthUtil.callGetRequest(API_HOST, ACCESS_KEY, SECRET_KEY, requestURI, customHeaderMap, canonicalQueryString);
        log(cloudvHttpResponse);

	//form-Urlencoded方式的post请求调用示例
        body = "videoName=" + java.net.URLEncoder.encode("测", "utf-8") + "&pageIndex=2&pageSize=5&format=json";
        cloudvHttpResponse = ApiAuthUtil.callPostFormUrlencodedBodyRequest(API_HOST, ACCESS_KEY, SECRET_KEY, requestURI, customHeaderMap, body);
        log(cloudvHttpResponse);
		
		
	//通过map方式传入URL参数的请求方式
        Map<String, String> map = new HashMap<String, String>();
        map.put("videoName", "测");
        map.put("pageIndex", "2");
        map.put("pageSize", "5");
        map.put("format", "json");
        cloudvHttpResponse = ApiAuthUtil.callPostFormUrlencodedBodyRequest(API_HOST, ACCESS_KEY, SECRET_KEY, requestURI, customHeaderMap, map);
        log(cloudvHttpResponse);

        System.out.print("调用完毕");

    }

    public static void log(CloudvHttpResponse cloudvHttpResponse) throws Exception {
	//每次请求统一会带上一个X-WS-RequestId用来方便排查问题
        System.out.println("返回结果是：" + cloudvHttpResponse + " , requestId = " + cloudvHttpResponse.getHeaders().get("X-WS-RequestId"));
    }

}