跳转到内容

使用 API Key

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

在网页中创建

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

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

WebSocket 连接

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

完整说明见 WebSocket API

const WebSocket = require('ws');
const ws = new WebSocket(
`wss://api.hooknexus.com/ws/${ENDPOINT_ID}?apikey=${API_KEY}`
);
ws.on('message', (data) => {
const msg = JSON.parse(data.toString());
if (msg.type === 'new_request') {
console.log(msg.payload);
}
});

常见限额(以应用内为准)

套餐API Key 数量每端点 WebSocket 并发
Free1(控制台)
Plus13

详见 订阅方案

安全建议

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