TUTUCLOUD eva 视频融合 API 文档

接口鉴权

参数 sign 生成步骤：

1. 抽取所有请求参数 (类型为 file 的参数不参与签名)。
2. 对 参数名 以字典升序 (a-z) 进行排序。

    sortedParams = {
        "key1": "value1",
        "key2": "value2"
    }

3. 以 参数名参数值 的形式拼接排序后的参数。

    stringParams = "key1value1key2value2"

4. 把从控制台创建应用后获取的私钥 api_secret 作为后缀拼接到上一步生成的字符串后面, 得到 待签名字符串。

    stringParams = "key1value1key2value2api_secret"

5. 最后再对 待签名字符串 用 MD5 摘要算法，得到签名结果 sign (32位小写)。

    sign = md5("key1value1key2value2api_secret")

签名示例：

私钥 api_secret = "my_api_secret"

请求参数 = {
   "url": "http://my.test/my.jpg", 
   "api_key": "my_api_key",
   "timestamp": 123456
}

排序后参数 = {
    "api_key": "my_api_key",
    "timestamp": 123456,
    "url": "http://my.test/my.jpg"
}

待签名字符串 = "api_keymy_api_keytimestamp123456urlhttp://my.test/my.jpgmy_api_secret"

sign = "be83843c50dbfe8211256694c1cc5c58"

视频渲染请求

POST https://api.eva.tutucloud.com/v1/render

HTTP header

Content-Type: multipart/form-data

参数

assets args 参数

args 参数

cURL 请求示例

curl -X POST \
https://api.eva.tutucloud.com/v1/render \
-H 'content-type: multipart/form-data' \
-F api_key=39802830831bed188884e193d8465226 \
-F sign=04b29480233f4def5c875875b6bdc3b1 \
-F tpl_id=123 \
-F tpl_version=g234fdsafda12321 \
-F 'assets=[{"name":"re_img_3", "value":"http://my.test/my.jpg"},{"name":"re_txt_2019","value":"my_replace_text"}]'

返回示例

{
    "message": "Success",
    "code": 200,
    "data": {
        "task_id": "GfNE_AXLj0CHizT_9UDVp"
    }
}

如果有提供 notify_url 参数, 服务会在渲染结束后对渲染结果以 POST 方式, 通知内容格式为 content-type:application/json 的形式进行异步通知请求, 如果收到请求返回的 HTTP 响应状态码为 200 则视为通知成功. 如通知失败, 会在6分钟内额外进行7次通知 (分别在 10s 后, 20s 后, 40s 后, 70s 后, 120s 后, 200s 后, 330s 后). 通知内容的 json 示例如下.

// 异步通知内容示例
{
    "message": "Success",
    "code": 200, // 200 为渲染成功, 其它详见返回码
    "task_id": "GfNE_AXLj0CHizT_9UDVp",
    "sign": "14b29480233f4d2f5c875875b6bdc3b3",  // 收到通知请求后需对来源进行验证, 验证方式为 `md5("<task_id>+<api_secret>") == "<sign>"`
    "data": {
        "assets": [
            {
                "name": "re_img_3",
                "value": "http://file.eva.tutucloud.com/my/img/abc.jpg"
            },
            {
                "name": "re_txt_2019",
                "value": "my_replace_text"
            }
        ],
        "render_time": 48,
        "video": "http://file.eva.tutucloud.com/my.mp4"
    }
}

视频渲染状态查询

GET https://api.eva.tutucloud.com/v1/render/task

参数

cURL 请求示例

curl -X GET \
'https://api.eva.tutucloud.com/v1/render/task?task_id=GfNE_AXLj0CHizT_9UDVp&api_key=39802830831bed188884e193d8465226&sign=04b29480233f4def5c875875b6bdc3b1'

返回示例

{
    "message": "Success",
    "code": 200, // 200 为渲染成功, 渲染尚未完成时code为 4300, 其它详见返回码
    "data": {     
        "assets": [
            {
                "name": "re_img_3",
                "value": "http://file.eva.tutucloud.com/my/img/abc.jpg"
            },
            {
                "name": "re_txt_2019",
                "value": "my_replace_text"
            }
        ],
        "render_time": 48,
        "video": "http://file.eva.tutucloud.com/my.mp4"
    }
}

上传替换素材

POST https://api.eva.tutucloud.com/v1/asset

HTTP header

Content-Type: multipart/form-data

参数

cURL 请求示例 (img)

curl -X POST \
https://api.eva.tutucloud.com/v1/eva/asset \
-H 'content-type: multipart/form-data' \
-F api_key=39802830831bed188884e193d8465226 \
-F sign=04b29480233f4def5c875875b6bdc3b1 \
-F file=@my.jpg \
-F file=@my.mp4

cURL 请求示例 (url)

curl -X POST \
https://api.eva.tutucloud.com/v1/eva/asset \
-H 'content-type: multipart/form-data' \
-F api_key=39802830831bed188884e193d8465226 \
-F sign=04b29480233f4def5c875875b6bdc3b1 \
-F 'url=["http://my.test/my.jpg","http://my.test/my.mp4"]'

返回示例

{
    "message": "Success",
    "code": 200,
    "data": {
        "urls": [
            "http://file.eva.tutucloud.com/my.jpg",
            "http://file.eva.tutucloud.com/my.mp4"
        ]
    }
}

获取时间戳

GET https://api.eva.tutucloud.com/timestamp

如请求其它接口时传了timestamp参数, 服务器则会和当前时间进行比较, 如晚于服务器当前时间超过60秒, 则会拒绝服务。

参数

无

返回示例

{
  "message": "Success",
  "code": 200,
  "data": {
    "timestamp": 1553249584
  }
}

返回码