文档中心
查看文档
示例代码
接入技术服务
创建审查任务
API具体接入方式请参考智能合同API接入指引
功能描述
用户可以通过此API，上传审查文件，审查文件支持的类型包括png、jpg、jpeg、bmp、pdf、doc、docx、webp、tif、tiff、html、mhtml格式。创建审查任务后可以得到一个能在浏览器访问的预览url
请求URL
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 |
请求参数说明（Query Parameters）
| 字段名 | 类型 | 描述 |
|---|---|---|
| template_id | string | 规则id, 可在“规则审查配置”页面获取 |
请求体参数说明（Request Body）
Content-Type: multipart/form-data
| 字段名 | 类型 | 描述 |
|---|---|---|
| documents | file | 待上传的文件， 可以上传多张图片，审查结果会将图片合并；只能上传一个文档 |
响应体说明（Response）
Content-Type: application/json
JSON结构说明如下：
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 状态码，非200为错误码，见错误码详情 |
| msg | string | 状态说明 |
| data | object | 创建任务结果 |
data
| 字段名 | 类型 | 描述 |
|---|---|---|
| preview_url | string | 预览页面url，可以用于浏览器预览或者页面嵌入 |
| task_id | string | 任务id |
JSON结构示例
{
"data": {
"preview_url": "https://provider.contracts.textin.com/textin_for_contracts/robot/review?task_id=${task_id}",
"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配置不正确 |
