跳到主要内容

开发必读

接口地址前缀​

下方所有接口地址中用apiPrefix表示接口地址前缀，前缀组成为

/docs/publicapi/{apiVersion}
  • apiVersion目前为v1

目前缺省值是 /docs/publicapi/v1

接口请求体通用字段说明​

参数名类型说明是否必须
fileUrlstring文件下载地址是
tokenTypestring三方token类型，值为cookie或者header否
tokenValuestring三方token值，zOffice下载文件或回调通知时回传否
callbackstring回调地址。任务转换结束后zOffice回调通知状态是

fileUrl说明​

fileUrl的hostname需要与管理控制台该应用配置的"三方应用接口地址前缀"的hostname一致。

zOffice发送fileUrl请求下载文件时，会按照下方tokenType/tokenValue传递凭证。

tokenType和tokenValue说明​

  • 如果tokenType为cookie，则tokenValue格式应为key=value;key2=value2。

    • zOffice发送请求下载文件或者请求callback时，请求头Cookie的值会设置为tokenValue对应的值

  • 如果tokenType为header，则tokenValue为字符串。

    • zOffice发送请求下载文件或者请求callback时，请求头Authorization的值会设置为tokenValue对应的值

  • 如果tokenType为空，zOffice下载文件时，不携带任何特殊的认证信息。

callback说明​

  • 任务转换结束后，zOffice通过callback回调通知调用方，zOffice回调时回传给三方。
  • callback的hostname需要与一致管理控制台上注册的三方应用接口地址前缀的ostname一致 三方系统需要实现回调API，任务结束后，zOffice server调用此接口通知三方系统。

zOffice server调用此接口时，会采用tokenType和tokenValue说明的认证方式

  1. 处理POST请求
  2. 处理Content-Type为application/json

请求体结构

{
    "taskId": "任务ID",
    "code": "任务结果码",
    "detail": {
        // 详细信息
    }
}

code说明

  • 调用任务成功，code为TaskSuccessNotify或ConvertSuccessNotify；
  • 调用任务失败，code为TaskFailNotify或ConvertFailNotify

任务成功通知：

{
    "taskId": "1c1cf10b-d9e6-4927-b75e-dddf6b441445",
    "code": "TaskSuccessNotify", // 或ConvertSuccessNotify
    "detail": {
        "taskStatus": "SUCCESS",
        "defaultDownloadPath": "/docs/open/v1/convert/download",
        "contentId": "640eeac02a9baf5dbc69d426",
        "filename": "demo-docx.pdf"
    }
}

任务失败通知：

msg中会描述任务失败原因

{
    "taskId": "1c1cf10b-d9e6-4927-b75e-dddf6b441445",
    "code": "TaskFailNotify", // 或ConvertFailNotify
    "detail": {
        "taskStatus": "FAIL",
        "msg": "conversion format err",
        "filename": "demo-docx.pdf"
    }
}
最后于 更新