links

POST `/v1/content/external-sites`

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

Toute la documentation pour développeurs →

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id (query)`	`string`	Non	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`url`	`string`	Oui	The site's address, e.g. `https://example.com` or `https://example.com/blog`.
`username`	`string`	Oui	—
`application_password`	`string`	Oui	The application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
`name`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`site_id`	`string`	Oui	—
`primary_domain`	`string`	Oui	—
`name`	`string`	Oui	—
`is_external`	`boolean`	Oui	Always true here. The same site appears in `/v1/sites` badged External.
`base_url`	`string`	Oui	The address we publish to, including any path (e.g. `https://example.com/blog`).
`reachable`	`boolean`	Non	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`	Non	—
`detail`	`string`	Non	What the site said last time, verbatim. Shown on the site's own screen.
`detected_identity`	`string`	Non	—
`backup`	`object`	Oui	Whether we can back this site up, and whether we can put it back. Served on the list so a screen showing a customer's whole external estate makes one request rather than one per…

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422