hosting
GET /v1/wordpress/plugin-directory/{slug}
One plugin from the WordPress directory.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/wordpress/plugin-directory/{slug} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A single plugin, with its long-form `sections` (description, installation notes, changelog, FAQ) which the search deliberately omits — they are tens of kilobytes per plugin and no list view renders them. ⛔ A slug the directory does not know is a **`404`**. The upstream answers `200` with an `error` field for an unknown slug, which a naive client would render as a real plugin whose every field is empty — one the customer could click Install on. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
slug (path) | string | はい | The directory slug, as the search returns it. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
slug | string | はい | The directory slug — what `installSiteWordPressPlugin` takes. ⛔ The **only** field from this resource that is ever sent to a box; the download URL is resolved by the site itself… |
name | string | はい | — |
version | string | はい | — |
author | string | はい | Plain text. The upstream's surrounding anchor markup is stripped. |
short_description | string | はい | — |
rating | number | はい | ⛔ **0–5, normalised here.** The upstream reports 0–100; a client rendering that as stars without dividing shows every plugin as full marks. |
num_ratings | integer | はい | — |
active_installs | integer | はい | The directory's own estimate, and it means "at least this many" — it is bucketed upstream, so 4,000,000 and 4,900,000 both arrive as 4000000. |
last_updated | string | はい | — |
requires_wp | string | はい | Minimum WordPress version. `""` when the plugin does not say. |
requires_php | string | はい | Minimum PHP version. `""` when the plugin does not say. |
tested_up_to | string | はい | The newest WordPress the author has tested against. |
homepage | string | はい | — |
icon_url | string | はい | The plugin's icon, best available size. `""` when it has none — ⛔ NOT the directory's grey placeholder, which would give every icon-less plugin the same picture: present, wrong,… |
sections | object | いいえ | Long-form copy (description, installation, changelog, FAQ), plain text. Present only on `getWordPressDirectoryPlugin`; the search omits it because it is tens of kilobytes per pl… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503