Quick Audience Open Platform API

Common parameter description

Sign the request as follows:

• Construct a canonicalized query string from the request parameters.

• Sort all request parameters by name in lexicographical order. This includes both common request parameters and any custom parameters for the specific API. Note: For GET requests, these parameters form the query string of the URI. The query string follows the question mark (?) and uses ampersands (&) as separators. The accessSecret parameter is also required to generate the signature.

• Encode the parameter names and values in UTF-8.

• URL-encode all URL parameters.

Code example

The following Java example shows how to generate the signature:

String appId="tttt";
String accessKey = "xxxx";
String accessSecret ="yyyy";
String timeStamp = "1708235644862";

SortedMap<String, String> map = new TreeMap<>();
map.put("appId", appId);
map.put("accessKey", accessKey);
map.put("accessSecret",accessSecret );
map.put("timestamp", timeStamp);
// If it is a GET request with other query parameters, add them here.

String aa = getCanonicalQueryString(map);
System.out.println(aa);
String authorization = org.apache.commons.codec.digest.DigestUtils.md5Hex(aa);
System.out.println(authorization);

public static String getCanonicalQueryString(SortedMap<String, String> paramsMap) {
        StringBuilder queryString = new StringBuilder();
        boolean isFirstParameter = true;

        for (Map.Entry<String, String> entry : paramsMap.entrySet()) {
            String paramName = entry.getKey();
            String value = entry.getValue();

            if (!isFirstParameter) {
                queryString.append("&");
            } else {
                isFirstParameter = false;
            }
            queryString.append(paramName).append("=").append(value);
        }
        return queryString.toString();
}

Example:

curl --location -g --request POST 'http://{Quick Audience public endpoint}/openapi/apipath/xxxx?appId=aaa&accessKey=xxx&timestamp=yyy' \
--header 'Authorization: demosign'

Quick Audience verifies the signature based on these parameters. If the application does not exist or the signature is incorrect, the request is rejected. For details about other API parameters, see the documentation for each API.