Webhooks
注册 Webhook
注册或更新接收开票结果等事件的回调 URL。
POST
/openapi/v1/webhooks需要 token、timestamp、sign 三个签名头,参见认证与签名。
每个应用只有一份回调配置:webHookId 即应用标识,再次调用会覆盖配置。注册会自动订阅结果事件(授权通过 / 被驳回)。连续投递失败触发熔断后,再次调用注册接口即可恢复投递。
参数
请求体
idstring更新时必填创建时返回的
webHookId;创建时省略,更新时携带(必须属于当前应用)。uristring必填接收回调的公网 https/http URL。
示例:https://webhook.site/816497e5-0b0e-42a5-abdf-d9040232bf9ccontentTypestring必填目前仅支持
application/json。取值:application/jsontokenstring必填自定义的校验令牌;每次回调都会在
token请求头中原样回传,供接收方校验来源。
响应
200
配置已保存。
webHookIdstring配置标识(等于应用标识)。更新时作为
id传入。
错误
| 错误码 | HTTP | |
|---|---|---|
| 10009033 | 400 | 注册无效: |
| 10001001 | 400 | 请求字段校验失败(每个字段一条)。 |
回调投递
平台向 uri 发起 POST,携带 token 头(注册时的值)与签名头 X-Tffiscal-Signature(以 app_secret 为密钥的 HMAC-SHA256),签名校验可选。接收方返回 HTTP 2xx 视为投递成功,其他响应会按退避策略重试。各事件的载荷格式见 Webhooks。
