跳转到内容
HookNexus

API Key

通过 API Key，你的服务器、脚本或工具可以用 WebSocket 实时接收 Webhook 事件，而不仅依赖浏览器控制台。

在网页中创建

API Key 仅在浏览器中创建与吊销，不在本文用接口演示。

  1. 打开 hooknexus.com 并登录。
  2. 进入 设置（或 账户 → API Key，以当前界面为准）。
  3. 选择 创建 API Key（或同类入口）。
  4. 可填写 名称，便于日后区分。
  5. 立即复制完整密钥 — 通常只显示一次。请保存到密码管理器或密钥托管环境。

安全建议

  • 将 Key 视为密码：不要写入公开仓库、聊天或前端打包代码。
  • 若泄露，请在同一设置页 吊销 并新建。
  • 建议使用环境变量或平台密钥能力（如 HOOKNEXUS_API_KEY）。

使用 API Key

当前文档说明的用法为 WebSocket 实时流：

wss://api.hooknexus.com/ws/<endpointId>?apikey=<your_api_key>

将 <endpointId> 换为你控制台中的端点 ID；将 <your_api_key> 换为创建时复制的密钥（若含特殊字符请做 URL 编码）。

消息格式与示例见 WebSocket。