通知比对任务结果

测试中

POST

开发者如果需要接受消息通知，需要提供一个“通知回调接口”，法狗狗方将在开发者执行相关操作时调用此“通知回调接口”回传内容通知开发者，开发者对header和body的内容进行处理。
回调接口响应数据要求：
●收到通知之后，响应"success" 即可。
●如未收到"success" 或请求请求超时，将按如下频率再次调用：1分钟，5分钟，1小时，三次调用后不再尝试。
●由于网络波动等原因，可能会产生重复的通知消息，接入方需要做好幂等，正确处理。

请求参数

Header 参数

fgg-logid

string

可选

统一日志id，当出现问题时可以提供此id给法狗狗研发人员协助定位问题

示例值:

780d9ac6-573d-4293-b8e2-b68ad14069e2

appid

string

开发者appid

必需

默认值:

fgg12345678987654321

timestamp

integer

10位数字时间戳

必需

默认值:

nonce

string

16位随机字符串

必需

默认值:

AcGIU5JK9KjKk7vq

sign

string

必需

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

默认值:

Body 参数application/json

type

string

必需

固定值，compare

status

enum<integer>

必需

10 任务不存在，可能已经被清理
12 比对成功
13 比对失败

枚举值:

101213

errorCode

integer

必需

比对失败时错误码
500 未知错误
408 文档转换失败--未知原因
40010 文档转换失败 -- 不支持或无法识别的格式
40012 office文档可能已损坏或加密
40404 PDF文件不存在: Url不可访问或文件损坏
409 比对超时
40900 文档差异可能过大

410 文档内容提取失败 -- 未知原因
40011 PDF文档可能已损坏
40013 PDF文档可能加密

412 文档页数过多

message

string

必需

taskId

string

任务id

必需

data

object

比对成功时带有

可选

elapsedTime

string

可选

similarity

string

可选

diffItemsCount

string

可选

addedCount

string

可选

changedCount

string

可选

removedCount

string

可选

extractedText

string

可选

differences

string

可选

ignoredDiffs

string

可选

示例

{
  "type": "compare",
  "status": 12,
  "progress": 100,
  "errorCode": 0,
  "message": "success",
  "data": {
    "forceImage": false,
    "similarity": 0.151313847062297,
    "diffItemsCount": 1,
    "addedCount": 0,
    "changedCount": 1,
    "removedCount": 0,
    "extractedText": {}
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '{{callbackUrl}}' \
--header 'fgg-logid: 780d9ac6-573d-4293-b8e2-b68ad14069e2' \
--header 'appid;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "compare",
    "status": 12,
    "progress": 100,
    "errorCode": 0,
    "message": "success",
    "data": {
        "forceImage": false,
        "similarity": 0.151313847062297,
        "diffItemsCount": 1,
        "addedCount": 0,
        "changedCount": 1,
        "removedCount": 0,
        "extractedText": {}
    }
}'

返回响应

🟢200成功

text/plain

Body

string

可选

示例

success

生成比对结果链接

比对任务列表