links
POST /v1/content/external-sites
Connect a WordPress site we do not host, with an application password.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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 | いいえ | — |
backup | object | はい | 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… |
このエンドポイントが返すエラー
401 · 403 · 422