Skip to content

SDK 与集成示例

EventRelay 暂无官方发布的 npm / PyPI / Composer / Go module 包。本节提供各语言 最小可运行片段,覆盖集成时最容易踩坑的三块:

  1. Open API 调用Authorization: Bearer {appid}:{open_secret}
  2. Callback 验签 — 必须用 原始请求体字节,见 Callback 验签
  3. 安全外链核销(可选)— POST /v1/open/context-links/verify,见 安全外链鉴权

环境变量(推荐)

bash
export EVENT_RELAY_API="https://er.iuu.pub"
export EVENT_RELAY_APPID="app_xxx"
export EVENT_RELAY_OPEN_SECRET="..."
export EVENT_RELAY_CALLBACK_SECRET="..."      # 仅验签 webhook 时需要

密钥在 开发者控制台 注册或 API 密钥 页重置后 仅此一次 明文展示。

语言指南

语言文档典型场景
Node.jsNode.jsExpress / Fastify webhook、服务端发 message
GoGo标准库验签与发 message
PythonPythonDjango / Flask / FastAPI
PHPPHPLaravel / 原生 php://input

集成检查清单

  • [ ] callback_url 为公网 HTTPS,返回 2xx
  • [ ] Webhook 路由读取 raw body 再验签(勿 json_decode 后再 json_encode
  • [ ] ext 字段用于业务对账,callback 原样回显
  • [ ] 用 POST /v1/open/webhooks/test 或控制台 测试 Webhook 先验连通
  • [ ] 敏感业务外链启用 context_secure,业务站验签后调用 /context-links/verify(见 安全外链
  • [ ] 生产与开发使用不同 open_secret / callback_secret(轮换后旧密钥立即失效)

相关文档

EventRelay 开发者文档