links

POST /v1/content/external-sites

Connect a WordPress site we do not host, with an application password.

所有 links 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/content/external-sites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "url": <string>, "username": <string>, "application_password": <string> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Gated on `links.edit`. The credential is **verified against the site before anything is stored**: if WordPress refuses it, nothing is created and the error says what to fix. The password goes to Vault; no secret is stored on the row. Generate the application password in that site's WordPress admin under Users → your user → Application Passwords. The user needs to be able to publish posts.

参数

名称类型必填内容简介
org_id (query)string

请求正文

名称类型必填内容简介
urlstringThe site's address, e.g. `https://example.com` or `https://example.com/blog`.
usernamestring
application_passwordstringThe application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
namestring

响应

名称类型必填内容简介
site_idstring
primary_domainstring
namestring
is_externalbooleanAlways true here. The same site appears in `/v1/sites` badged External.
base_urlstringThe address we publish to, including any path (e.g. `https://example.com/blog`).
reachablebooleanWhat the last check found. **`null` means we have not checked**, which is not the same as "it does not work" — an unchecked site is never rendered as broken.
checked_atstring
detailstringWhat the site said last time, verbatim. Shown on the site's own screen.
detected_identitystring

此端点可能返回的错误

401 · 403 · 422