创建比对任务（一对一）

测试中

POST

/openapi/compare/diff-task

请求参数

Header 参数

appid

string

开发者appid

必需

默认值:

fgg12345678987654321

timestamp

integer

10位数字时间戳

必需

默认值:

nonce

string

16位随机字符串

必需

默认值:

AcGIU5JK9KjKk7vq

sign

string

必需

签名（生成签名参见文档）

默认值:

Body 参数application/json

originFileName

string

源文件名称

必需

originFileUrl

string

源文件在线地址

必需

targetFileName

string

目标文件名称

必需

targetFileUrl

string

目标文件在线地址

必需

creator

string

任务创建者名字

可选

callbackUrl

string

可选

接收比对成功或失败的推送事件

ignorePunctuations

boolean

可选

忽略标点符号, 默认 true

ignorePageHeaderAndFooter

boolean

可选

忽略页眉页脚，默认 true
注：当前对 office 文档不生效，office 文档总是去页眉页脚和页码

ignoreComments

boolean

可选

忽略office文档批注，默认 true

acceptAllReverts

boolean

可选

接受office文档所有修订，默认 true

ignoreSeals

boolean

可选

忽略扫描件印章，默认 true

language

string

可选

可选chinese,english,chinese_cht，默认 chinese

originFilePageRange

string

可选

半角逗号分隔多个范围，例1-2,4-5

targetFilePageRange

string

可选

半角逗号分隔多个范围，例1-2,4-5

startWord

string

开始位置

可选

关键词必须是连续的，不能带有空格换行

endWord

string

结束位置

可选

关键词必须是连续的，不能带有空格换行

textOnly

boolean

可选

textOnly 模式不支持扫描件和图像， { code: 41502, message: 'textOnly 模式不支持扫描件和图像'}

示例

{
  "originFileName": "string",
  "originFileUrl": "string",
  "targetFileName": "string",
  "targetFileUrl": "string",
  "taskId": "string",
  "creator": "string",
  "callbackUrl": "string",
  "ignorePunctuations": true,
  "ignorePageHeaderAndFooter": true,
  "ignoreComments": true,
  "acceptAllReverts": true,
  "ignoreSeals": true,
  "language": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/openapi/compare/diff-task' \
--header 'appid;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "originFileName": "string",
    "originFileUrl": "string",
    "targetFileName": "string",
    "targetFileUrl": "string",
    "taskId": "string",
    "creator": "string",
    "callbackUrl": "string",
    "ignorePunctuations": true,
    "ignorePageHeaderAndFooter": true,
    "ignoreComments": true,
    "acceptAllReverts": true,
    "ignoreSeals": true,
    "language": "string"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

可选

data

object

必需

taskId

string

任务id

必需

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "taskId": "string"
  }
}

修改于 2024-11-20 02:28:58

智能比对调用说明

创建比对任务（一对多）