links

POST `/v1/content/external-sites`

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

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`string`	Não	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`url`	`string`	Sim	The site's address, e.g. `https://example.com` or `https://example.com/blog`.
`username`	`string`	Sim	—
`application_password`	`string`	Sim	The application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
`name`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`string`	Sim	—
`primary_domain`	`string`	Sim	—
`name`	`string`	Sim	—
`is_external`	`boolean`	Sim	Always true here. The same site appears in `/v1/sites` badged External.
`base_url`	`string`	Sim	The address we publish to, including any path (e.g. `https://example.com/blog`).
`reachable`	`boolean`	Não	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`	Não	—
`detail`	`string`	Não	What the site said last time, verbatim. Shown on the site's own screen.
`detected_identity`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 422