For each request, Cloud VoD will verify the identity through the Authorization Header in the request.

In this section, we will take the example of getting video list from Cloud VoD and show you how to make up an Authorization Header step by step.
The URL of getting video list is:
https://api.cloudv.haplat.net/vod/videoManage/getVideoList

How to Use

The Authorization is consist of Algorithm, AccessKey Secret, SignedHeaders and Signature. The Algorithm is a fixed value at WS3-HMAC-SHA256, so the Authorization looks as the following:

Authorization：WS3-HMAC-SHA256
Credential=<AccessKeyId >/<Date>/<Region>/<Service>/wos_request,
SignedHeaders=<SignedHeader>;<SignedHeader>;<SignedHeader>,
Signature=<Signature>

And the overall calculation process goes as following:

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)))

Recommended Calculation Steps

Task 1: Create a Canonical Request

To begin the signing process, you have to create a string that includes information from your request in a standardized (canonical) format. This ensures that when Cloud VoD receives the request, the service side can calculate the same signature that you calculated.

You should create a canonical request as the following format:

<HTTPMethod> + "\n" +
<RequestURI> + "\n" +
<QueryString> + "\n" +
<CanonicalHeaders> + "\n" +
<SignedHeaders> + "\n" +
<HashedPayload>

In the canonical request:

For this example, the CanonicalRequest is:

POST
/vod/videoManage/getVideoList
content-type:application/json; charset=utf-8
host:api.cloudv.haplat.net
content-type;host
641f7989f8d223af8c5049f805890fcaf2ae4a99780a01eb454cf7c9368dd1a4

Task 2: Create a String to Sign

The string to sign includes meta information about your request and about the canonical request that you created in Task 1: Create a canonical request for Signature. You will use the string to sign and a derived signing key that you create later as inputs to calculate the request signature in Task 3: Calculate the signature.

The string to sign is a concatenation of the following strings:

StringToSign =
    Algorithm + \n +
    Timestamp + \n +
    HashedCanonicalRequest

Note: You need to ensure that the timestamp and standard time are synchronized, otherwise it will fail if the time difference is more than five minutes. If your system has not synchronized with the standard time for a long time, the request may fail and return an expired signature error due to the timestamp expiration.

For this example, the StringToSign is:

WS3-HMAC-SHA256
1564645579
16bc1b4d4e6818f5aec2a7273cb2c3d3e4831fd61c6510222b9bec19bffac646

Task 3: Calculate Signature

The signature is the HMAC-SHA256 hash of the string to sign that you make from task 2, usi- ng your accessKey Secret as the key for hash-encode. The calculation method is as follows:

Signature = HMAC-SHA256(SigningKey, StringToSign)

Note: Make sure you specify the HMAC parameters in the correct order for the programming language you are using. This example shows the key as the first parameter and the data (message) as the second parameter, but the function that you use might specify the key and data in a different order.*

Task 4: Create Authorization

The Authorization is the value that you should put in your request Header for authentication. The resulting Authorization can be made as follows:

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

According to the info above, we can get a Authorization as follows:

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

And the final request is:

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"}

Error Codes

curl Example

POST Request

content-type:application/json

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

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

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"

For GET Requests, the Content-Type must be application/x-www-form-urlencoded.