links

POST /v1/content/external-sites

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

Alle links Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Parameter

NameTypErforderlichWas es ist
org_id (query)stringNein

Anfragekörper

NameTypErforderlichWas es ist
urlstringJaThe site's address, e.g. `https://example.com` or `https://example.com/blog`.
usernamestringJa
application_passwordstringJaThe application password WordPress generated. Spaces are ignored, so it may be pasted exactly as displayed.
namestringNein

Antwort

NameTypErforderlichWas es ist
site_idstringJa
primary_domainstringJa
namestringJa
is_externalbooleanJaAlways true here. The same site appears in `/v1/sites` badged External.
base_urlstringJaThe address we publish to, including any path (e.g. `https://example.com/blog`).
reachablebooleanNeinWhat 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_atstringNein
detailstringNeinWhat the site said last time, verbatim. Shown on the site's own screen.
detected_identitystringNein

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422