links
POST /v1/site-links/ingest
Receive one batch of a site's outbound-link scan (signed webhook).
身份验证
此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/site-links/ingest \
-H "Content-Type: application/json" \
-d '{ "site": <string>, "scan_id": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
What a site's Zinn® plugin POSTs when its scheduled link scan runs: the posts it looked at, and for each one every outbound <a> tag it found, with how many times that tag appears in that post. Machine-to-machine; there is no principal. Authentication is the same HMAC scheme ingestSiteEvents uses — SHA-256 over "<timestamp>\n<body>" in X-Zinn-Cache-Signature, with X-Zinn-Cache-Timestamp carrying the unix seconds, against a secret derived per site from the platform master key. ⛔ Deliberately not a second scheme: one secret, one derivation, one place for the two ends to agree. The organisation comes from the resolved site and never from the body. A scan is a SNAPSHOT, delivered in batches. One pass over a site carries one scan_id across as many requests as it takes; the request carrying complete: true triggers reconciliation, which deletes every post and placement for that site not stamped with that pass. ⛔ That is what makes a link the customer removed disappear from the report — an append-only index rots into a permanent overcount and looks authoritative while it does. ⛔ An abandoned pass deletes nothing. No completing batch, no sweep: the report goes stale rather than wrong-by-deletion. ⛔ A batch from a superseded pass is ignored whole and answers ignored: true. The plugin's POST is fire-and-forget with a two-second timeout, so a batch landing after the next cron tick has begun is expected; mixing it in would let a finished pass sweep away the live one's rows. Every refusal is uninformative on purpose — an unknown hostname is a bare 404 and a bad signature a bare 401, because a chattier answer would tell anyone who can guess a hostname which domains this platform hosts.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
X-Zinn-Cache-Timestamp (header) | string | 是 | Unix seconds. Signed as part of the material, which is what bounds a replay. |
X-Zinn-Cache-Signature (header) | string | 是 | sha256=<hex>. |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
site | string | 是 | The site's own home_url(). An untrusted claim — it selects which site's derived secret the signature is checked against, and nothing more. |
scan_id | string | 是 | Identifies the pass, not the request. Minted by the plugin, because one pass spans many requests and the engine cannot mint it. Opaque: nothing is inferred from its value, and… |
complete | boolean | 否 | ⛔ Only a literal true ends the pass. A missing key, a null or the string "false" all mean "not complete", because reading one as complete would sweep away every post the… |
posts_sent | integer | 否 | Posts this pass has sent so far, cumulative across batches, as counted by the site. ⛔⛔ Load-bearing on the completing batch: the POST is non-blocking, so a site never learns… |
posts | object[] | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
accepted | boolean | 是 | — |
ignored | boolean | 是 | The batch belonged to a superseded pass and was dropped whole. Expected occasionally: the plugin's POST is fire-and-forget with a two-second timeout. |
posts | integer | 是 | — |
links | integer | 是 | — |
truncated | boolean | 是 | A post reported more links than the per-post ceiling and the tail was dropped. Surfaced rather than swallowed — a report that silently under-counts is worse than one that says it… |
reconciled | boolean | 是 | This batch completed the pass, so the snapshot sweep ran. |
removed | integer | 是 | Rows the sweep deleted. ⭐ The only externally visible proof the snapshot reconciliation works: a site whose links change while this stays 0 on every pass is the append-only rot… |
refused | string | 否 | Why a completing batch was not swept, when it was not — a lost batch, or one whose post list was truncated. ⛔ Reported rather than swallowed: a pass that keeps completing… |
此端点可能返回的错误
401 · 404 · 422 · 503