合同抽取

接入指引

1．概述

本文档适用于没有认证服务，或者有不满足OIDC标准的认证服务但是不希望做额外的代码开发的客户。用于指引客户接入TextIn合同抽取公有云API。

方案概述:

接入TextIn合同抽取公有云API时，客户需要在调用创建抽取任务时传入令牌标识。
每次创建完任务获取到的preview_url后，需要额外调用申请令牌接口，并将获取到的令牌拼接到preview_url后，方可访问。

2．接入指引

2.1 采用令牌认证模式创建抽取任务

在调用创建抽取任务api的请求体中增加一个字段"token_mode":1

具体调用方法参考公有云合同抽取API文档

请求体示例:

{"token_mode":1,"creator":"xxx","config":{"engine":"table","use_pdf_parser":"true","use_semantic_match":"true","remove_watermark":"false"},"filedata":["图片1base64","图片2base64","图片3base64"],"filename":"文件.imgs","key_info_list":[{"key_info":"甲方","paraphrase_names":["甲方名称"],"field_type":"name","is_in_table":true,"keywords":["甲"]}]}

调用此API可以得到如下的返回结果

{
    "result": {
        "preview_url": "https://contracts.textin.com/textin_for_contracts/robot/keyinfo/extraction?task_id=a684556077a285a2ff456d1614fc8bf1",
        "task_id": "a684556077a285a2ff456d1614fc8bf1",
        "extracted_results_url": "https://doc-compare.intsig.com/doc_extraction/keyinfo/extracted_results?task_id=a684556077a285a2ff456d1614fc8bf1&format=json"
    },
    "code": 200,
    "msg": "success"
}

在令牌认证的接入过程中，我们只需要preview_url和task_id。

2.2 获取认证令牌

调用token获取API，获取认证token。

token 获取API

请求URL

https://doc-compare.intsig.com/api/contracts/v3/extraction/external/token/apply

HTTP请求方法（Method）

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）

Conten-Type:application/json

JSON示例:

{"task_ids":["606a26c5957e46c7a985f1dc5931dad5"]}

请求字段说明: task_ids填入调用创建抽取任务后返回结果中的task_id。

响应体说明（Response）

Content-Type:application/json

JSON结构说明如下:

{"code":200,"data":{"token":"e97935b1-bc06-4154-a6b2-65e7536a435f"},"msg":"success"}

2.3 拼接 preview_url

通过2.1和2.2分别获得preview_url和token。需要将两个结果拼接。

拼接方式为:

${preview_url}&token=${token}

示例如下: https://contracts.textin.com/textin_for_contracts/robot/keyinfo/extraction?taskid=606a26c5957e46c7a985fldc5931dad5&token=e97935b1-bc06-4154-a6b2-65e7536a435f

拼接后的新url可以在浏览器中打开。token的有效期为20分钟，token超时后需要重新进行2.2和2.3的步骤