Quick Audience:Quick Audience オープンプラットフォーム API

共通パラメーターの説明

リクエストには、次のように署名します：

• リクエストパラメーターから正規化されたクエリ文字列を作成します。

• 署名の計算に使用するすべてのパラメーター (accessSecret を含む) を、パラメーター名で辞書順に並べ替えます。これらのパラメーターには、共通パラメーターと API 固有のカスタムパラメーターの両方が含まれます。注：GET リクエストの場合、これらのパラメーター (accessSecret を除く) が URI のクエリ文字列を構成します。クエリ文字列は、疑問符 (?) の後に続き、アンパサンド (&) を区切り文字として使用します。

• パラメーター名と値を UTF-8 でエンコードします。

• URL-encode all URL parameters.

コード例

以下の Java コード例は、署名の生成方法を示します。

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);
// API 固有の追加パラメーターがある場合は、ここに追加します。

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();
}

例：

curl --location -g --request POST 'http://{ドメイン名}/openapi/apipath/xxxx?appId=aaa&accessKey=xxx&timestamp=yyy' \
--header 'Authorization: demosign'

Quick Audience はこれらのパラメーターに基づいて署名を検証します。アプリケーションが存在しない場合、または署名が正しくない場合、リクエストは拒否されます。その他の API パラメーターの詳細については、各 API のドキュメントをご参照ください。