PDF转换服务API文档v1(pdf2docx.cn)

概述

本文档是www.pdf2docx.cn提供的PDF转换服务的API接口说明，包括文件上传、状态查询和文件下载等接口。为保证API的安全使用，本服务采用了API密钥和签名机制进行鉴权。

服务地址

• HTTP服务地址: http://api.pdf2docx.cn
• HTTPS服务地址: https://api.pdf2docx.cn

API鉴权

请求参数

所有API请求都必须在URL参数中包含以下鉴权信息：

• apikey (必需): 分配给用户的API密钥。（apikey和apisecret请联系管理员获取）
• timestamp (必需): 发起请求时的时间戳（秒），用于防止重放攻击。
• signature (必需): 使用API密钥和请求参数生成的签名，用于验证请求的合法性。

签名生成方法

1. 将除signature外的所有请求参数按照参数名的字典序排序。
2. 将排序后的参数用&连接成字符串，形成待签名字符串。
3. 使用SHA-256哈希算法对待签名字符串进行哈希运算，得到的哈希值即为签名。

接口说明

1. 文件上传接口

请求方法： POST

请求URL： /openapi/upload

请求参数：

请求体类型为multipart/form-data。

• uploadFile (必需): 需要上传的文件，作为表单数据的一部分。
• type (必需): 文件转换类型，例如 “pdf2word”，支持的类型包括pdf2word、pdf2ppt、pdf2excel、word2pdf、ppt2pdf、excel2pdf等。

响应： JSON 格式

• taskID (字符串): 任务的唯一标识符。
• status (字符串): 任务的初始状态，取值范围为processing、success、failed。

请求成功时的响应：

{
    "taskID": "123456789",
    "status": "processing"
}

请求失败时的响应：

{
    "error": "Invalid file type",
    "taskID": "",
    "status": "failed"
}

2. 任务状态查询接口

请求方法： GET

请求URL： /openapi/status

请求参数：

• taskID (必需): 需要查询状态的任务的唯一标识符。

响应： JSON 格式

• progress (整数): 任务的完成进度，范围从 0 到 100。
• status (字符串): 任务的当前状态，可能的值包括 "processing"、"completed"、或 "failed"。

任务完成时的响应：

{
    "progress": 100,
    "status": "completed"
}

任务失败时的响应：

{
    "progress": 0,
    "status": "failed",
    "error": "Conversion error"
}

3. 文件下载接口

请求方法： GET

请求URL： /openapi/download

请求参数：

• taskID (必需): 需要下载文件的任务的唯一标识符。

响应： 转换后的文件内容，以二进制形式直接发送，或在发生错误时返回错误信息。

联系方式

如有任何问题或需要帮助，请联系PDF转换服务提供商https://www.pdf2docx.cn/。

邮箱: [email protected]

微信: pangao826