转为文档结果查询

查询PDF、图片转为文档格式的转换结果

基本信息

请求路径：GET /api/developer/v1/tasks/convert/to/:office_type/:task_id

Header 参数

参数	必须	类型	说明
Date	是	string	使用 RFC1123 时间格式的当前时间
Content-Md5	是	string	HTTP Body 中数据的 MD5 值十六进制表达方式, 必需小写, 如果是 get 请求一律使用 URI 计算 MD5
Content-Type	是	string	目前固定为: application/json
Authorization	是	string	"WPS-2:" + app_id + ":" + sha1( app_key + Content-Md5 + Content-Type + DATE)

Path 参数

参数	必须	类型	说明
office_type	是	string	转换为的文件类型：docx,xlsx,pptx,json
task_id	是	string	格式转换任务 id，有效期1个小时，请及时保存转换结果

返回参数

参数	必须	类型	说明
code	是	integer	错误码
+ data	是	data {}	响应数据
status		string	转换任务状态， 1：结束 2：运行中 3：被中断 4：发生错误 5：阻塞中，还在队列里
progress		int	转换任务进度
errMsgs		string	转换任务失败原因
duration		int	转换耗时，单位秒
download_url		string	已转换完成的下载地址
start_time		int	开始转换的时间戳
page_count		int	已转换的页数

示例

请求示例

Shell

curl --request GET \
	--url https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891 \
	--header 'Authorization: WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a' \
	--header 'Content-Md5: d41d8cd98f00b204e9800998ecf8427e' \
	--header 'Content-Type: application/json' \
	--header 'Date: Wed, 23 Jan 2013 06:43:08 GMT'

Java

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891")
	.get()
	.addHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	.addHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	.addHeader("Content-Type", "application/json")
	.addHeader("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a")
	.build();

Response response = client.newCall(request).execute();

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	req.Header.Add("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Python

import http.client

conn = http.client.HTTPSConnection("solution.wps.cn")

headers = {
    'Date': "Wed, 23 Jan 2013 06:43:08 GMT",
    'Content-Md5': "d41d8cd98f00b204e9800998ecf8427e",
    'Content-Type': "application/json",
    'Authorization': "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a"
    }

conn.request("GET", "/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
	CURLOPT_HTTPHEADER => [
		"Authorization: WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a",
		"Content-Md5: d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type: application/json",
		"Date: Wed, 23 Jan 2013 06:43:08 GMT"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

JS

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("GET", "https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891");
xhr.setRequestHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
xhr.setRequestHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");

xhr.send(data);

Node.js

const http = require("https");

const options = {
	"method": "GET",
	"hostname": "solution.wps.cn",
	"port": null,
	"path": "/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891",
	"headers": {
		"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
		"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type": "application/json",
		"Authorization": "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a"
	}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.end();

C

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Date: Wed, 23 Jan 2013 06:43:08 GMT");
headers = curl_slist_append(headers, "Content-Md5: d41d8cd98f00b204e9800998ecf8427e");
headers = curl_slist_append(headers, "Content-Type: application/json");
headers = curl_slist_append(headers, "Authorization: WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

C#

var client = new RestClient("https://solution.wps.cn/api/developer/v1/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891");
var request = new RestRequest(Method.GET);
request.AddHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
request.AddHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");
IRestResponse response = client.Execute(request);

返回示例

{
    "code": 0,
    "data": {
        "status": 1,
        "duration": 4.074,
        "download_url": "http://zhai-platereduction.ks3-cn-beijing.ksyun.com/tmp/layout_test/pdfwriter/tmp/2023-10-23/0f27ff302780428e9ddfd39189731891.docx?Expires=1698633007&AWSAccessKeyId=AKLTvraLpUToTR6_PmBcKXIRCw&Signature=y9UFdStk19xj7E7fM1JkHvrvmBA%3D",
        "task_id": "0f27ff302780428e9ddfd39189731891",
        "progress": 100,
        "start_time": 1698028203329,
        "page_count": 3,
        "errMsgs": null
    }
}

说明

转换状态 status为1和progress为100时，表示转换完成，才会返回download_url。

本查询接口需要轮询，可根据progress的进度进行相关业务提示，并间隔一定时间再次查询，直到终止状态。

错误码

请参考错误码说明