金山文档开放平台

主题

回到顶部
本页内容

文档转换成 txt

将文档格式转换成 txt

基本信息

请求方法：POST

请求路径：/api/v1/openapi/office/convert/files/to/txt

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
100 次/天
正式应用
200 次/天

目前支持的文档类型

文档类型扩展名
演示
.pptx .ppt
WPS 文字
.docx .doc
WPS 表格
.xlsx .xls
WPS PDF
.pdf
参数必须类型说明
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)

Body 参数

参数必须类型说明
url
是
string
文档下载地址
filename
是
string
文档名称，包含扩展名，例如：说明文档.pdf
password
否
string
文档打开密码(如果文档有加密，该项则必填)
long_txt
否
bool
是否转换成长文本，设置为 true 时，可以将需要导出的页中的文字合并导出。默认值为 false，按页导出 txt
hold_line_feed
否
bool
转换 txt 时是否保留文档中的换行符，设置为 true 时，导出内容包含换行符。默认值为 false，导出内容不包含换行。
ranges
否
string
自定义需要转换的分页范围，例如："1,2-4,7"，则表示转换文档的 1、2、3、4、7 页面 (与 from_page和to_page 互斥)
from_page
否
int
转换起始页，从 1 开始计数(与 ranges互斥)
to_page
否
int
转换结束页，需要大于 from_page， (与 ranges互斥)

返回参数

参数必须类型说明
code
是
integer
错误码
+
data
是
data {}
响应数据

示例

请求示例 

curl --request POST \
	--url https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt \
	--header 'Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a' \
	--header 'Content-Md5: d41d8cd98f00b204e9800998ecf8427e' \
	--header 'Content-Type: application/json' \
	--header 'Date: Wed, 23 Jan 2013 06:43:08 GMT' \
	--data '{"url":"https://xxx.com/xxx","filename":"说明文档.pdf","long_txt":true}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt")
	.post(body)
	.addHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	.addHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	.addHeader("Content-Type", "application/json")
	.addHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")
	.build();

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

package main

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

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt"

	payload := strings.NewReader("{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}")

	req, _ := http.NewRequest("POST", url, payload)

	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:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")

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

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

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

}

import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

payload = "{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}"

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

conn.request("POST", "/api/v1/openapi/office/convert/files/to/txt", payload, headers)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => "{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}",
	CURLOPT_HTTPHEADER => [
		"Authorization: WPS-2:SX20220101ABCDEF: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;
}

const data = JSON.stringify({
	"url": "https://xxx.com/xxx",
	"filename": "说明文档.pdf",
	"long_txt": true
});

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

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

xhr.open("POST", "https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt");
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:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/office/convert/files/to/txt",
	"headers": {
		"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
		"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type": "application/json",
		"Authorization": "WPS-2:SX20220101ABCDEF: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.write(JSON.stringify({url: 'https://xxx.com/xxx', filename: '说明文档.pdf', long_txt: true}));
req.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt");

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:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/office/convert/files/to/txt");
var request = new RestRequest(Method.POST);
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:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
request.AddParameter("application/json", "{\"url\":\"https://xxx.com/xxx\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "task_id": "open:zjsiwfuotpbqblrlfwtkfkioargjbla"
  },
  "result": "ok"
}

查询异步任务结果

携带 task_id查询结果

其中 result 对象说明

参数必须类型说明
+
txts
否
txts[]
转换后的 txt 文件列表

返回示例 

{
  "code": 0,
  "data": {
    "status": "success",
    "progress": 100,
    "result": {
      "txts": [
        {
          "url": "https://xxx.com/xxx",
          "size": 70154
        },
        {
          "url": "https://xxx.com/xxx",
          "size": 112172
        },
        {
          "url": "https://xxx.com/xxx",
          "size": 954
        },
        {
          "url": "https://xxx.com/xxx",
          "size": 35327
        }
      ]
    }
  }
}

错误码

请参考错误码说明