使用 API Key

API Key 让服务器、脚本或任务通过 WebSocket 接收 Webhook，而不必一直开着浏览器控制台。

警告

Plus 提供 API Key；Free 不包含。

在网页中创建

1. 登录 hooknexus.com。
2. 打开 设置 → API Key（以当前界面为准）。
3. 点击 新建（或同类按钮）。
4. 按需填写名称。
5. 立即复制完整密钥 — 通常只显示一次。若丢失，请吊销后重新创建。

在同一设置页可 吊销 Key；吊销后立即失效，相关 WebSocket 会断开。

WebSocket 连接

wss://api.hooknexus.com/ws/{endpoint-id}?apikey={your-api-key}

当前 API Key 通过 URL 上的 apikey 查询参数鉴权，不使用 Authorization 请求头。

该连接会占用该 endpoint 的 WebSocket 并发数，并与 Dashboard、CLI 等其他在线监听端共享同一上限。

完整说明见 WebSocket API，完整可运行示例见 Node.js API Key 监听示例。

Node.js

const WebSocket = require('ws');
const endpointId = process.env.ENDPOINT_ID;
const apiKey = process.env.HOOKNEXUS_API_KEY;

const ws = new WebSocket(
  `wss://api.hooknexus.com/ws/${endpointId}?apikey=${encodeURIComponent(apiKey)}`
);

ws.on('message', (data) => {
  const msg = JSON.parse(data.toString());
  if (msg.type === 'new_request') {
    console.log(msg.payload);
  }
  if (msg.type === 'replay_request') {
    console.log(msg.payload?.request);
  }
});

Python

import asyncio, json, websockets

async def listen():
    url = f"wss://api.hooknexus.com/ws/{ENDPOINT_ID}?apikey={API_KEY}"
    async with websockets.connect(url) as ws:
        async for msg in ws:
            data = json.loads(msg)
            if data.get("type") == "new_request":
                print(data.get("payload"))

asyncio.run(listen())

常见限额（以应用内为准）

套餐	API Key 数量	每端点 WebSocket 并发
Free	—	2（控制台、CLI 等共享该上限）
Plus	1	3

详见 订阅方案。

若你的脚本只关心实时请求，建议忽略未知消息类型，并在断线后使用退避重连。

安全建议

1. 使用环境变量保存密钥。
2. 不同用途使用不同 Key，便于单独吊销。
3. 仅在后端使用，不要写进前端打包代码。
4. 怀疑泄露时立即吊销并新建。