合同比对

功能描述

用户可以通过此API，上传比对文件，比对文件支持的类型包括 png,jpeg,jpg,tif,tiff,ofd,pdf,doc,docx,wps,xls,xlsx,txt格式。创建比对任务后可以得到一个能在浏览器访问的预览url，比对任务id和获取比对差异信息的接口url。

请求URL

https://doc-compare.intsig.com/api/contracts/v3/comparison/external/create

HTTP请求方法（Method）

HTTP POST

请求头说明（Request Headers）

请在HTTP请求中添加以下自定义Header。

header 名	值
x-ti-app-id	请登录textin平台后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code	请登录textin平台后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

请求体说明（Request Body）

Content-Type: application/json JSON 结构说明如下：

字段名	类型	描述
creator	string	创建人, 可选
convert_arg	object	文档处理所需参数
+remove_comments	integer	是否删除批注，1为删除, 0不删除（只支持word）,比对文档不全是word时，此项填0即可
+remove_headerfooter	integer	是否删除页眉页脚，1为删除, 0不删除（只支持word）,比对文档不全是word时，此项填0即可
+remove_stamp	integer	是否移除印章， 1移除，0不移除
+remove_symbol	integer	是否忽略标点符号，1为忽略, 0不忽略
+merge_diff	integer	是否合并差异，1为合并, 0不不合并, 默认合并
+ignored_symbols	string	remove_symbol 参数为 1 时生效，指定需要忽略的符号，忽略的符号不参与比对，不指定默认忽略！，+:：;.。/^-=<>、？℅✔口~~¢£¤$¥￥§©«®°±»àáèéìíòó÷ùúāēěīōūǎǐǒǔǘǚǜΔΣΦΩ฿‰₣₤₩₫€₰₱₳₴℃℉≈≠≤≥①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯⑰⑱⑲⑳■▶★☆☑☒✓々「」『』【】〒〖〗〔〕㎡㎥・･…‼⁀'⁞⳹⦔〚⦒⸌_፥‽༺༑៖᨟]﹂⸠﹣⟫༌⁗︼•⧘᳓៕․᠆⌉܃๚༈︸෴᠅⸻܌፣❰֊｝¿⁊❱⸝܊⁌‗﹘܈⸅·⁽⧙¶﹄⦘︾᛭⧚༏‵﹍※⁓჻⁕༽᚜?⦅❫⸣〝❳՚׳܉፨〟؞‶⁚︴⧽⸧༒⁾“܋⁘⌊⟮︘‛܍੶࿑︗√﹎៙᱿﹁፠―׀؊،಄༆❵‚⁑‘⸉᛫－᳄︱’%༎᛬†［⸍“”@׆༊৽﹈։࿔၍⧛〛٫⸤⁆₎］{❮·⁝܁༉⁁⌈⌋）՜‣!；‖︵܆᠃⟨〰⦄⸩༐᠂⁜༼︷՞⟦⁖❯,๛⹂⦌༄᚛⁋❩⸺⦎《﹝࿓⦍་៘（☐﹞؉⁉⳾⸡༅࿚၏᠈}゠٪﹛᠀❲„＿〉፦⳺।๏፡᠉‥‐〜⟯־︺‾❬⦓﹚‴□)༻”〈([︳⸗›၊₍᠁᠇﹜‷︿⦊՟܅᠊⟪፧｛፤⁛》⸄&〞᱾❨¡❪⦕߷၌⦃⦏﹏܄｟⦐॰៚⸦;׃‹⁃⁔܀⸨﴿⟩⦗｢❭﴾။⁈⳼⹀⁏܂‸⁎⟭༔︻–#࿒⟬⳻〈⁂٭⦖՛॥⁅⦑⟧྅។⦇⸥‟࿐‱　｠⦉૰࿙።⁍⦋‿⟆܇༇〙߹⁇⸚︶᙮⸃߸″﹇‐︲؟︹〉⧼᠄′❴⟅︽⦆٬۔⸂〘⸜՝⦈｣⳿⁙﹃᨞⁐‒﹀⸊།—؍⸢﹙᐀״၎‡㎥・･
standard_doc	array	上传的标准文档，数组，长度限制为1
compare_doc	array	上传的被比对文档，数组，长度为n
config	object	解析文档配置，不传此参数，默认值为产品端全局配置

standard_doc

字段名	类型	描述
filedata	string	文件base64,不包含文件base64头信息
filename	string	文件名，长度不得超过255个字符

compare_doc

字段名	类型	描述
filedata	string	文件base64,不包含文件base64头信息
filename	string	文件名，长度不得超过255个字符

config

字段名	类型	描述	参数可选	默认值	选项
use_pdf_parser	string	使用pdf解析，传"false"则使用OCR识别文档	可选	“true”	“true”, “false”
remove_watermark	string	非电子档使用水印擦除引擎，需要GPU且需要部署水印擦出引擎，会增加抽取时间	可选	“false”	“true”, “false”

JSON示例：

{"creator":"xxxx","convert_arg":{"remove_stamp":1,"remove_comments":0,"remove_headerfooter":0,"remove_symbol":1,"merge_diff":1,"ignored_symbols":"①②③④⑤"},"config":{"use_pdf_parser":"true","remove_watermark":"false"},"standard_doc":[{"filedata":"base64","filename":"ex1.docx"}],"compare_doc":[{"filedata":"base64","filename":"ex2.docx"},{"filedata":"base64","filename":"ex3.pdf"}]}

响应体说明（Response）

Content-Type: application/json

JSON结构说明如下：

字段名	类型	描述
code	int	状态码，非200为错误码，见错误码详情
msg	string	状态说明
data	object	创建比对结果

data

字段名	类型	描述
preview_url	string	预览页面url，可以用于浏览器预览或者页面嵌入
task_id	string	任务id
diff_info_url	string	比对详情api url, 调用方式参考文档
similarity_url	string	接口内容已整合进 diff_info_url，返回结果和 diff_info_url 一样

JSON结构示例

{
    "data": {
        "preview_url": "https://provider.contracts.textin.com/textin_for_contracts/robot/contract?task_id=${task_id}",
        "task_id": "${task_id}",
        "similarity_url": "https://doc-compare.intsig.com/doc_compare/compared_similarity?task_id=${task_id}",
        "diff_info_url" : "https://doc-compare.intsig.com/doc_compare/diff_info?task_id=${task_id}"
    },
    "code": 200,
    "msg": "success"
}

错误码说明

错误码	描述
200	创建成功
209	任务进行中
400	坏的请求
401	未授权
403	禁止访问
404	未找到资源
406	参数错误
500	服务器内部错误
40003	余额不足，请充值后再使用
40004	参数错误，请查看技术文档，检查传参
40007	机器人不存在或未发布
40008	机器人未开通，请至市场开通后重试
40101	x-ti-app-id 或 x-ti-secret-code 为空
40102	x-ti-app-id 或 x-ti-secret-code 无效，验证失败
40103	客户端IP不在白名单
40104	App has expired 应用已超过有效期
40105	Invalid IP source 无效的IP来源
40106	App does not match service 应用与service不匹配
40107	App has been overdrawn. Please use it after recharging. 应用额度已用完，请充值后使用
40109	QPS limit reached, request rejected 达到 qps 限制，请求拒绝
40202	Service not support 请求了不支持的服务
40203	API is not configured correctly. API配置不正确