跳转到内容

API 概述

HookNexus 业务 API 基址为:

https://api.hooknexus.com

本参考主要说明两类用法:

  • 接收 Webhook — 第三方向你分配的地址 https://api.hooknexus.com/h/:endpointId 发送 HTTP 请求即可,不需要 API Key。
  • 实时订阅 — 使用在网页中创建的 API Key,通过 WebSocket 接收同一端点上的事件。详见 API KeyWebSocket

账号、计费与日常配置请在网页端 hooknexus.com 完成。

数据格式

使用 JSON 时,请求与响应一般为 UTF-8Content-Type 多为 application/json

速率与配额

具体上限取决于你的订阅(例如每日 Webhook 量、请求体大小、WebSocket 并发等)。触发上限时可能返回 429 Too Many Requests 或带简短说明的错误 JSON。

常见 HTTP 状态码

状态码含义
200成功
201已创建
400请求无效(参数、JSON 等)
401未通过校验(例如缺少或错误的 API Key)
403无权限(套餐、资源归属或功能限制)
404不存在
413请求体过大
429频率或配额超限
500服务器错误