快速开始
在应用的 Wire → API 密钥中创建密钥,然后即可在任何地方调用 API。响应为 JSON,时间为 ISO-8601 UTC。
curl -H "Authorization: Bearer rr_live_…" \
https://realityradar-7h6.pages.dev/api/v1/public/alerts?limit=5const res = await fetch('https://realityradar-7h6.pages.dev/api/v1/public/entities', {
method: 'POST',
headers: { Authorization: `Bearer ${process.env.RADAR_KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({ entityType: 'software_version', displayName: 'Node.js', modelOrVersion: '18.20.0',
identifiers: { eolProduct: 'nodejs' }, relationship: 'used' }),
});
console.log(res.status, await res.json());import os, requests
r = requests.get("https://realityradar-7h6.pages.dev/api/v1/public/events", params={"type": "product_recall", "limit": 20},
headers={"Authorization": f"Bearer {os.environ['RADAR_KEY']}"}, timeout=10)
r.raise_for_status()
for e in r.json()["items"]:
print(e["firstSeenAt"], e["title"], e["sourceUrl"])身份验证
以 Bearer 令牌发送密钥。密钥只显示一次,仅以哈希保存,可设置 30、90 或 365 天后过期,并可在 24 小时重叠期内轮换。
Authorization: Bearer rr_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX权限范围
每个密钥只带有你选择的权限范围。超出范围的请求返回 403 insufficient_scope,因此只读密钥无法添加项目或管理 Webhook。
| 权限范围 | 端点 |
|---|---|
read:signals | GET /public/eventsGET /public/events/{id} |
read:entities | GET /public/entities |
write:entities | POST /public/entities |
read:alerts | GET /public/alerts |
manage:webhooks | GET /public/webhooksPOST /public/webhooksDELETE /public/webhooks/{id}GET /public/webhooks/{id}/deliveriesPOST /public/webhooks/{id}/deliveries/{deliveryId}/replay |
速率限制
标准密钥每分钟 60 次,高配额密钥每分钟 300 次。收到 429 时请等待后重试;每个密钥和端点的用量可在 Wire 中查看。
分页
列表端点返回 items 和 nextCursor。持续传回 cursor 直到其为 null;游标不透明,翻页期间保持稳定。
cursor = None
while True:
page = requests.get(f"https://realityradar-7h6.pages.dev/api/v1/public/events", headers=H, params={"limit": 100, "cursor": cursor}).json()
handle(page["items"])
cursor = page["nextCursor"]
if not cursor:
break错误
错误使用统一格式和固定的机器码。5xx 与 429 可按退避策略重试,4xx 表示请求有问题。
{ "error": { "code": "insufficient_scope", "message": "This key lacks the \"write:entities\" scope" } }invalid_api_key | 401 | 缺少密钥、格式错误或已吊销 |
api_key_expired | 401 | 已超过有效期或轮换宽限期 |
insufficient_scope | 403 | 密钥缺少此端点所需的权限范围 |
not_found | 404 | 不存在,或此工作区不可见 |
plan_limit | 409 | 已达到免费方案的项目上限 |
ssrf_blocked | 422 | URL 指向私有或内部地址 |
rate_limited | 429 | 请求过多 — 请稍后重试 |
Webhook
当达到你所设级别的警报生成时,以 POST 发送 JSON 事件。投递记录保留 30 天,包含状态和延迟,并可一键重发。
POST /your/endpoint
Content-Type: application/json
User-Agent: RealityRadar-Webhook/1.0
X-Radar-Signature: t=1761112800,v1=5f2b…a91c,v1=03de…77b0
{"type":"alert.created","alert":{"impactLevel":"critical","matchType":"exact",…},"event":{…}}验证签名
用密钥对 t、点号和原始请求体计算 HMAC-SHA256,以常数时间与任一 v1 比较,并拒绝超过五分钟的时间戳。轮换密钥后的 24 小时内会收到两个 v1。
import { createHmac, timingSafeEqual } from 'node:crypto';
// rawBody: the exact bytes you received (do not re-serialize JSON)
export function verifyRadar(header, rawBody, secret) {
const parts = header.split(',').map((p) => p.split('='));
const t = Number(parts.find(([k]) => k === 't')?.[1]);
const sigs = parts.filter(([k]) => k === 'v1').map(([, v]) => v);
if (!Number.isFinite(t) || Math.abs(Date.now() / 1000 - t) > 300) return false;
const mac = createHmac('sha256', secret).update(`${t}.${rawBody}`).digest('hex');
return sigs.some((v) => v.length === mac.length && timingSafeEqual(Buffer.from(v), Buffer.from(mac)));
}import hmac, hashlib, time
def verify_radar(header: str, raw_body: bytes, secret: str) -> bool:
parts = [p.split("=", 1) for p in header.split(",")]
t = next((int(v) for k, v in parts if k == "t"), None)
sigs = [v for k, v in parts if k == "v1"]
if t is None or abs(time.time() - t) > 300:
return False
mac = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
return any(hmac.compare_digest(mac, s) for s in sigs)func VerifyRadar(header string, rawBody []byte, secret string) bool {
var t int64 = -1
var sigs []string
for _, p := range strings.Split(header, ",") {
k, v, ok := strings.Cut(p, "=")
if !ok { continue }
if k == "t" { t, _ = strconv.ParseInt(v, 10, 64) }
if k == "v1" { sigs = append(sigs, v) }
}
if t < 0 || math.Abs(float64(time.Now().Unix()-t)) > 300 { return false }
m := hmac.New(sha256.New, []byte(secret))
fmt.Fprintf(m, "%d.", t)
m.Write(rawBody)
want := hex.EncodeToString(m.Sum(nil))
for _, s := range sigs {
if hmac.Equal([]byte(want), []byte(s)) { return true }
}
return false
}# Replay a delivery (fresh timestamp + signature)
curl -X POST -H "Authorization: Bearer rr_live_…" \
https://realityradar-7h6.pages.dev/api/v1/public/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID/replay依赖与 OSV
用 pkg:npm/lodash 这样的 purl 和确切版本追踪软件包。系统会查询 OSV.dev,若你的版本在受影响列表中则标记为完全匹配。锁文件或 SBOM 可在应用的导入中上传。
curl -X POST -H "Authorization: Bearer rr_live_…" -H "Content-Type: application/json" \
-d '{"entityType":"software_version","displayName":"lodash","modelOrVersion":"4.17.20","identifiers":{"purl":"pkg:npm/lodash"},"relationship":"used"}' \
https://realityradar-7h6.pages.dev/api/v1/public/entities术语表
响应中会出现的术语。
- Signal(信号)
- 从官方来源检测到的变化事件,附有证据和时间。
- Beacon(信标)
- 数据来源。A 级为官方监管机构或厂商,B 级为经过整理的数据库。
- 匹配类型
- exact、strong、probable、weak — 表示事件与你的项目相关的确定程度。只有 exact 和 strong 会被表述为确定。
- 相关性、可信度、严重性
- 分别计算的三个 0–100 分数:是否与你有关、证据有多可信、变化有多严重。
- purl
- 软件包 URL,如 pkg:npm/lodash,是 OSV 匹配所用的标准标识符。
- 证据账本
- 所存每条证据组成的防篡改哈希链,任何人都可以验证。