How to authenticate your requests to our API.
Last updated
public class ApiClient {
public static void main(String[] args) {
String appId = "your_app_id";
String apiKey = "your_api_key";
BaseReq params = new BaseReq();
params.setXXX("your_data");
long timestamp = System.currentTimeMillis();
String jsonString = JsonSorterUtils.objectToJsonSorted(params);
String signature = SignatureUtil.generateSignature(appId, apiKey, jsonString, timestamp);
System.out.println("signature: " + signature);
}
}timestamp = int(time.time() * 1000)
if __name__ == "__main__":
class GenerateVideoReq:
def __init__(self):
self.webhook_url = "XXXXXX"
self.params = {
"voice_id": "XXXX",
"avatar_id": XX,
"text": "XXXX rain social services and economic growth.",
"language": "English"
}
client_id = "your_app_id";
auth_key = "your_api_key";
req = GenerateVideoReq()
data = JsonSorter.object_to_json_sorted(req);
signature = generate_signature(client_id, auth_key, data, timestamp)public String generateSignature(String clientId, String authKey, String data, long timestamp) {
String message = clientId + data + timestamp;
Mac mac = null;
try {
mac = Mac.getInstance("HmacSHA256");
} catch (NoSuchAlgorithmException e) {
throw new SignatureException("HmacSHA256 is not supported");
}
SecretKeySpec secretKeySpec = new SecretKeySpec(authKey.getBytes(), "HmacSHA256");
try {
mac.init(secretKeySpec);
} catch (InvalidKeyException e) {
throw new SignatureException("Invalid key");
}
byte[] hash = mac.doFinal(message.getBytes());
return Base64.getEncoder().encodeToString(hash);
}def generate_signature(client_id, auth_key, data, timestamp):
message = f"{client_id}{data}{timestamp}"
mac = hmac.new(auth_key.encode('utf-8'), message.encode('utf-8'), hashlib.sha256)
signature = base64.b64encode(mac.digest()).decode('utf-8')
return signatureimport com.alibaba.fastjson2.JSONObject;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.TypeReference;
import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;
public class JsonSorterUtils {
/**
* Converts the object into a sorted, compact JSON string。
*
* @param obj The object to be converted
* @return A compact sorted JSON string
*/
public static String objectToJsonSorted(Object obj) {
Map<String, Object> map = JSON.parseObject(JSON.toJSONString(obj), new TypeReference<Map<String, Object>>() {});
return JSON.toJSONString(sortMap(map));
}
/**
* Sort the Map and recursively sort the Jsonobjects in it
*
* @param map Map that needs to be sorted
* @return The sorted Map
*/
private static Map<String, Object> sortMap(Map<String, Object> map) {
if (map == null) return null;
// Sort the external fields using TreeMap
SortedMap<String, Object> sortedMap = new TreeMap<>(map);
// Iterate through the Map and sort each JSONObject recursively
for (Map.Entry<String, Object> entry : sortedMap.entrySet()) {
if (entry.getValue() instanceof JSONObject) {
// If it is JSONObject, it is converted to Map before sorting
Map<String, Object> nestedMap =
JSON.parseObject(entry.getValue().toString(), new TypeReference<Map<String, Object>>() {});
entry.setValue(sortMap(nestedMap));
} else if (entry.getValue() instanceof Map) {
// If it is a Map, it is sorted recursively
entry.setValue(sortMap((Map<String, Object>) entry.getValue()));
}
}
return sortedMap;
}
}import json
class JsonSorter:
@staticmethod
def object_to_json_sorted(obj):
obj_dict = JsonSorter._convert_to_dict(obj)
sorted_dict = JsonSorter._sort_dict(obj_dict)
return json.dumps(sorted_dict, separators=(',', ':'))
@staticmethod
def _convert_to_dict(obj):
if isinstance(obj, dict):
return obj
elif hasattr(obj, '__dict__'):
return obj.__dict__
elif isinstance(obj, str):
return json.loads(obj)
else:
raise ValueError("Unsupported type")
@staticmethod
def _sort_dict(d):
sorted_items = sorted(d.items())
sorted_dict = {}
for key, value in sorted_items:
if isinstance(value, dict):
sorted_dict[key] = JsonSorter._sort_dict(value)
else:
sorted_dict[key] = value
return sorted_dictcurl --request POST \
--url https://vidau-app.superads.cn/openapi/ \
--header 'Content-Type: application/json' \
--header 'Authorization: signatureXXXXX' \
--header 'timestamp: 1723515690000' \
--header 'x-auth-key: you-auth-key' \
--data '{
"url": "https://vidau-app.superads.cn"
}'