links

POST `/v1/content/external-sites`

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

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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`	Нет	—

Тело запроса

Имя	Тип	Обязательно	Что это
`url`	`string`	Да	The site's address, e.g. `https://example.com` or `https://example.com/blog`.
`username`	`string`	Да	—
`application_password`	`string`	Да	The application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
`name`	`string`	Нет	—

Ответ

Имя	Тип	Обязательно	Что это
`site_id`	`string`	Да	—
`primary_domain`	`string`	Да	—
`name`	`string`	Да	—
`is_external`	`boolean`	Да	Always true here. The same site appears in `/v1/sites` badged External.
`base_url`	`string`	Да	The address we publish to, including any path (e.g. `https://example.com/blog`).
`reachable`	`boolean`	Нет	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`	Нет	—
`detail`	`string`	Нет	What the site said last time, verbatim. Shown on the site's own screen.
`detected_identity`	`string`	Нет	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 422

POST /v1/content/external-sites