终点
终点是可以接收 webhook 事件的有效 HTTP URL。
HTTP Headers
当将入口的请求路由到终点目标时,终点收到的 HTTP 请求方法默认和入口一样,nanhook
会保留原始请求的标头、正文、查询字符串和路径。
下面列出了此规则的更详细详细信息:
除了请求的原始标头之外,nanhook
在每个 HTTP 请求添加了以下标头:
标头名称 | 说明 |
---|---|
X-Nanhook-Delivery-Id | 派送编号,对于每个事件而言都是唯一的,可用于防范重放攻击 |
X-Nanhook-Attempt-Count | 重新派送时,尝试的次数 |
当 终点网址
不是第三方服务商时,nanhook
在每个 HTTP 请求还添加了以下标头:
标头名称 | 说明 |
---|---|
X-Nanhook-Connecting-Ip | 连接到入口的客户端 IP |
X-Nanhook-Source-Provider | 入口的验证方式 |
X-Nanhook-Source-Http-Method | 入口的 http 请求方法 |
X-Nanhook-Source-Url-Path | 入口的 url path |
X-Nanhook-Source-Url-Query | 入口的 url query 参数 |
HTTP Response
终点响应从 nanhook
收到的事件时,请牢记终点要使用反映系统实际状态的 HTTP 状态码响应每个请求。
处理操作时,响应 HTTP 2XX 表示成功,或响应 HTTP 4XX - 5XX 表示失败。
终点必须在 10 秒内响应请求,否则将得到超时状态码 -1,并在 nanhook
中标记为失败。然后重试。
新增终点
创建终点,填写有效的 终点网址
,nanhook
可以将收到 webhook 事件传递到终点。
状态
当 状态
没有选择 可用
时,终点状态是“禁用”,连接终点的路由状况是停用的,路由的入口收到 webhook 事件不会传递到路由的终点。
验证
可以选择性地对请求进行身份验证。nanhook
支持的通用身份验证选项:
- 基本身份验证
basic auth
- API 密钥验证
api key
- 持票人令牌验证
Bearer token
- 密钥散列消息验证
hmac
涵盖了大多数身份验证需求。
此外,nanhook
还内置支持许多第三方服务商的身份验证。有关第三方服务商的完整列表,请参阅终点第三方身份验证提供商。
配置终点请求的身份验证:
- 选择验证请求的真实性;
- 从下拉框中选择一个验证方法;
- 填写身份验证方法所需的信息。
删除
终点删除将永久停止 终点网址
。
终点关联的请求和事件数据将在有效时段内保留。
一旦终点被删除,它关联的路由也被删除。