links

POST `/v1/content/external-sites`

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

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`string`	Ne	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`url`	`string`	Ano	The site's address, e.g. `https://example.com` or `https://example.com/blog`.
`username`	`string`	Ano	—
`application_password`	`string`	Ano	The application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
`name`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`site_id`	`string`	Ano	—
`primary_domain`	`string`	Ano	—
`name`	`string`	Ano	—
`is_external`	`boolean`	Ano	Always true here. The same site appears in `/v1/sites` badged External.
`base_url`	`string`	Ano	The address we publish to, including any path (e.g. `https://example.com/blog`).
`reachable`	`boolean`	Ne	What 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_at`	`string`	Ne	—
`detail`	`string`	Ne	What the site said last time, verbatim. Shown on the site's own screen.
`detected_identity`	`string`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422