鹏城转码 API

api

更新历史

目录

【备注】

1. 错误码

当请求发生错误时，系统返回错误码和错误描述；错误分为 客户端错误 和 服务端错误

HTTP请求状态列表，4xx为客户端错误，5xx为服务端错误

HTTP请求状态返回格式

错误样例
{
"code": 11001,
"error": "core expired"
}

2. 回调地址说明

• 回调地址功能

  sewise server 执行调用者请求的任务后返回结果通知

• 接口地址

  自定义

• HTTP请求类型

  GET/POST

• 请求参数

  参数	必选	类型	说明
  data	是	String	Json格式的回调结果，并做URLEncode

• 接口示例

  Request
  回调地址：uploadCallback = http://callback.sewise.com/api/callback
  回调数据：data = URLEncode(data)
  curl -X GET http://callback.sewise.com/api/callback?data=%7B%22filepath%22%3A%22test%22%7D
  Response
  {"success":true}

3. 时间定义

• UNIX TIME

以下接口中，类型为 UNIX TIME 的时间均为 UTC+0 时间

• 时间格式化
  

  通过字符串传入的时间，格式为 yyyy-MM-ddTHH:mm:ssTZ

核心能力接口

1. 文件直传

接口功能

支持用户将本地文件上传到sewise的流媒体服务器（支持断点续传，需客户端支持）

• 文件上传握手

接口功能

文件上传握手操作，系统根据请求参数返回该文件相应的上传操作指导

接口地址

/api/file/fupload

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
source_id	是	String	该文件的MD5值，该值将作为sewise系统为该文件的唯一标识码

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"source_id":"1234qwer"} http://api.sewise.com/api/file/fupload/qwerasdfzxcvtyuiqwerasdfzxcvtyui
Response
{"source_id":"qwerasdfzxcvtyuiqwerasdfzxcvtyui","status":1,"upload_url":"http://api.sewise.com/api/upload"}

接口功能

支持用户将本地文件上传到sewise的流媒体服务器,支持用户以Form表单形式上传完整文件

接口地址

/api/file/fupload

HTTP Content-Type

multipart/form-data

HTTP 请求方式

POST

请求报文格式

POST /api/file/ HTTP/1.1
Content-Type: multipart/form-data; boundary="----=_Part_6_19788992.1452675017567"
Content-Length: 8418
Host: localhost:8888
Connection: Keep-Alive

------=_Part_6_19788992.1452675017567
Content-Disposition: form-data; name="source_id"

{source_id}
------=_Part_6_19788992.1452675017567
Content-Disposition: form-data; name="file_name"

{file_name}
------=_Part_6_19788992.1452675017567
Content-Disposition: form-data; name="tag"

{tag}
------=_Part_6_19788992.1452675017567
Content-Disposition: form-data; name="upload_callback"

{upload_callback}
------=_Part_6_19788992.1452675017567
Content-Type: video/mp4; name=test.jpg
Content-Transfer-Encoding: binary
Content-Disposition: form-data; name="test.mp4"; filename="test.mp4"

{file_binary_data}
------=_Part_6_19788992.1452675017567--

请求参数

参数	必选	类型	说明
RequestBody
source_id	否	String	该文件的MD5值，该值将作为sewise系统为该文件的唯一标识码
tag	否	String	文件标签
file_name	否	String	默认使用文件的 sourceid 为文件名
capture_image	否	Boolean	默认不截取封面图片
upload_callback	否	String	文件上传结果回调地址，返回数据格式为 【5.文件查询】-【HTTP响应状态】-200-【data】-【Response Item】，回调请求说明请参照 【备注】-【回调地址说明】；若不存在回调地址，可以通过文件查询接口获取上传文件的信息
file_binary_data	是	Binary	二进制文件数据（需要上传的文件）

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
curl -F "file=@e:/test.mp4" -F "source_id=1234qwer" -F "file_name=1234qwer" -F "tag=sd" -F "capture_image=false" -F "upload_callback=http://api.sewise.com/api/callback" http://api.sewise.com/api/file/fupload

Response
{"source_id":"1234qwer"}

2. 文件分片上传

接口功能

支持用户将本地文件上传到sewise的流媒体服务器（支持断点续传，需客户端支持）

• 文件上传握手

接口功能

文件上传握手操作，系统根据请求参数返回该文件相应的上传操作指导

接口地址

/api/file/upload

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
source_id	是	String	该文件的MD5值，该值将作为sewise系统为该文件的唯一标识码
file_size	是	Long	文件大小，单位为byte
slice_size	是	Integer	文件分块大小
slice_nums	是	Integer	文件分块数目
suffix_name	是	String	文件扩展名
tag	否	String	文件标签
file_name	否	String	默认使用文件的 sourceid 为文件名
capture_image	否	Boolean	默认不截取封面图片
upload_callback	否	String	文件上传结果回调地址，返回数据格式为 【5.文件查询】-【HTTP响应状态】-200-【data】-【Response Item】，回调请求说明请参照 【备注】-【回调地址说明】；若不存在回调地址，可以通过文件查询接口获取上传文件的信息

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"file_size":10000,"slice_size":250,"slice_nums":40,
"upload_callback":"http://callback.sewise.com/api/callback"} http://api.sewise.com/api/file/upload/qwerasdfzxcvtyuiqwerasdfzxcvtyui
Response
{"source_id":"qwerasdfzxcvtyuiqwerasdfzxcvtyui","status":1,"upload_set":{"file_size":1000,"slice_size":25,"slice_nums":40,"slice_arr":[4]}}

• 文件分块上传

接口功能

上传分片文件，客户端需串行上传文件

接口地址

/api/file/upload/{source_id}/{slice_id}

HTTP Content-Type

application/octet-stream

HTTP 请求方式

PUT

请求参数

参数	必选	类型	说明
PathParam
source_id	是	String	文件ID
slice_id	是	Integer	文件分块序号

请求内容

文件分块的二进制数据

HTTP 响应状态

200

接口示例

Request
curl -X PUT -H "Content-Type:application/octet-stream" http://api.sewise.com/api/file/upload/qwerasdfzxcvtyuiqwerasdfzxcvtyui/1
Response
{"source_id":"qwerasdfzxcvtyuiqwerasdfzxcvtyui","slice_id":1}

3. 文件删除

接口功能

删除已上传的文件，包括与该资源相关的内容

接口地址

/api/file/{source_id[,source_id]}

HTTP Content-Type

application/json

HTTP 请求方式

DELETE

请求参数

参数	必选	类型	说明
PathParam
source_id	是	String	视频id，可以批量操作，格式如下xxx,xxx

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X DELETE -H "Content-Type:application/json" http://api.sewise.com/api/file/qwerasdfzxcvtyuiqwerasdfzxcvtyui
,qwerasdfzxcvtyuiqwerasdfzxcvtyu7
Response
{"result":[{"success":true,"source_id":"qwerasdfzxcvtyuiqwerasdfzxcvtyui"}]}

4. 文件查询

接口功能

查询文件的详细信息

接口地址

/api/file/{source_id[,source_id]}

HTTP Content-Type

application/json

请求方式

GET

请求参数

参数	必选	类型	说明
PathParam
source_id	否	String	视频id，可以批量操作，格式如下xxx,xxx
QureyParam
tag	否	String	当source_id不存在，可根据tag查询，支持多tag查询，格式如 tag1,tag2
status	否	Integer	当source_id不存在，可根据status查询，获取指定状态的文件信息
size	否	Integer	当source_id不存在，可设置查询文件个数，默认为20
page	否	Integer	当source_id不存在，可设置查询文件的页数，默认为1

HTTP 响应状态

200

Response Item

FileInfo Item

JobInfo Item

Multiple Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X GET -H "Content-Type:application/json" http://api.sewise.com/api/file/1234qwerasdfzxcv1234qwerasdfzxcv
Response
{"total_record":1,"total_page":1,"page":1,"size":1,"data":[{"source_id":1234qwerasdfzxcv1234qwerasdfzxcv,"status":2,"create_time":1445307741210,"file_info":{"file_size":10000,"format":"ts","duration":300,"vcodec":"h264","acode":"aac","dimension":"640x480","bitrate":"200","framerate":"30","samplerate":"44100","channles":2}}]}

5. 文件下载

接口功能

下载指定文件

接口地址

/api/file/download/{source_id}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
PathParam
source_id	是	String	视频id
QueryParam
format	否	String	视频格式

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X GET -H "Content-Type:application/json" http://api.sewise.com/api/file/download/qwerasdfzxcvtyuiqwerasdfzxcvtyui
Response
{"url":"http://download.sewise.com/qwerasdfzxcvtyuiqwerasdfzxcvtyui.flv"}

6. 文件转码

接口功能

对已上传成功的文件根据需求执行转码操作

接口地址

/api/file/transcode/{source_id}

HTTP Content-Type

application/json

请求方式

POST

请求参数

参数	必选	类型	说明
PathParam
source_id	是	String	文件ID
RequestBody
template_id	是	String(8)	转码参数模板ID，8位任意字符串组成，系统默认的转码模板ID除外；系统默认已设定三种转码模板可供使用，id分别为tp_sd,tp_hd,tp_shd，详细信息请看 【备注】-【转码模板】
trans_callback	否	String	转码任务结果回调地址；回调地址格式请参照【备注】-【回调地址说明】；回调数据格式为 【查询转码】-【HTTP 响应状态】- 200 -【data】-【Response Item】-【Multiple Item】;

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X POST -H "Content-Type:aplication/json" -d {"template_id":"tp_sd","trans_callback":"http://callback.sewise.com/api/callback"} http://api.sewise.com/api/file/transcode/1234qwer
Response
{"job_id":"1234qwer"}

7. 取消转码

接口功能

取消正在进行的转码任务

接口地址

/api/file/transcode/{job_id[,job_id]}

HTTP Content-Type

application/json

请求方式

PUT

请求参数

参数	必选	类型	说明
PathParam
job_id	是	String(8)	转码任务ID，可以批量操作，格式如：xxx,xxx

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X POST -H "Content-Type:aplication/json" http://api.sewise.com/api/file/transcode/1234qwer,qwer1234
Response
{"result":[{"job_id":"1234qwer","success":true},{"job_id":"qwer1234","success":true}]}

8. 查询转码

接口功能

查询正在进行的转码任务

接口地址

/api/file/transcode/{job_id[,job_id]}

HTTP Content-Type

application/json

请求方式

GET

请求参数

参数	必选	类型	说明
PathParam
job_id	否	String(8)	文件ID,支持批量操作，格式为xxx,xxx
QueryParam
size	否	Integer	查询任务的数量，默认为20
page	否	Integer	查询任务的页数，默认为1

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X GET -H "Content-Type:application/json" http://api.sewise.com/api/transcode/1234qwer
Response
{"total_record":1,"total_page":1,"page":1,"size":1,"data":[{"job_id":"1234qwer","template_id":"qwerasdf","status":"1"，"process":"20.01"，"create_time":1445307741210}]}

9. 转码模板设置

接口功能

自定义合适的转码模板

接口地址

/api/transtemplate

HTTP Content-Type

application/json

请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
template_name	否	String	转码模板的名称
params	是	String	Json格式的转码参数列表，详细信息请看 Request Item

Request Item

Video Params

Audio Params

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X POST -H "Content-Type:application/json" -d {"template_name":"标清","params":{"video":{},"audio":{}}} http://api.sewise.com/api/transtemplate
Response
{"template_id":"qwerasdf"}

10. 更新转码模板

接口功能

更新指定的转码模板

接口地址

/api/transtemplate/{template_id}

HTTP Content-Type

application/json

请求方式

PUT

请求参数

参数	必选	类型	说明
PathParam
template_id	是	String(8)	转码模板ID
RequestBody
params	是	String	Json格式的转码参数列表，详细信息请看 Request Item

Request Item

Video Params

Audio Params

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X PUT -H "Content-Type:application/json" -d {"params":{"video":{},"audio":{}}} http://api.sewise.com/api/transtemplate/qwerasdf
Response
{"success":true}

11. 获取转码模板信息

接口功能

获取指定或者全部的转码模板信息

接口地址

/api/transtemplate/{template_id[,template_id]}

HTTP Content-Type

application/json

请求方式

GET

请求参数

参数	必选	类型	说明
PathParam
template_id	否	String(8)	转码模板ID，可以批量操作，格式为xxxx,xxxx
QureyParam
page	否	Integer	查询日志的页数，默认为1
size	否	Integer	查询每页日志的条数，默认为20

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X GET -H "Content-Type:application/json" -d {"keyword":"ssss"} http://api.sewise.com/api/transtemplate/qwerasdf
Response
{"total_record":1,"total_page":1,"page":1,"size":1,"data":[{"template_id":"1234qwer","template_name":"hd","params":{}}]}

12. 删除转码模板

接口功能

删除指定转码模板

接口地址

/api/transtemplate/{template_id[,template_id]}

HTTP Content-Type

application/json

请求方式

DELETE

请求参数

参数	必选	类型	说明
PathParam
template_id	是	String(8)	转码模板ID，可以批量操作，格式为xxxx,xxxx

HTTP 响应状态

200

Response Item

其他响应状态描述请参照：【备注】-【错误码】

使用示例

Request
curl -X DELETE -H "Content-Type:application/json" http://api.sewise.com/api/transtemplate/qwerasdf
Response
{"result":[{"template_id":"qwerasdf","success":true}]}