运营

API包括用于上传源文件,下订单,检索有关订单和文件的信息的操作,以及下载订单的已完成文档(转录物或标题)或源文件。

下面是每个操作的摘要,以及与具有详细规格的页面的链接。

手术 HTTP资源/动词 评论
上传文件 邮寄/投入

客户端可以上传文件或发送可以从中检索文件的URL。

返回一个用于识别文件时的URI,用于在放置转录或字幕订单时识别文件

放置转录令 发布/订单

订单将被收取客户的账户余额

可以可选地包括将发送关于订单的更新的通知URL。

返回订单的摘要,包括价格,以及可以检索订单详细信息的URL

放置字幕订单 发布/订单

订单将被收取客户的账户余额

可以可选地包括将发送关于订单的更新的通知URL。

返回订单的摘要,包括价格,以及可以检索订单详细信息的URL

获取订单详细信息 GET / ORDERS / {ORDER_NUM}

使用给定订单号返回有关订单的详细信息。这包括有关文件的信息和任何已完成的成绩单或标题,订单的整体状态以及订单交换的任何评论

列出用户的订单 获取/订单

返回用户放置的订单的摘要信息列表。

列表以分页方式返回以支持高效的操作

取消订单 发布/订单/取消

如果工作尚未启动,则只能取消订单

获取附件信息 get /附件/ {id}

返回关于附件(原始文件,脚本或标题)的元数据,给定的ID

获取附件内容 获取/附件/ {ID} /内容

返回具有给定ID的附件(原始文件,脚本或标题)的实际文件数据。使用请求标题,您可以指定应返回附件的格式(例如,明文)