hosting

GET /v1/wordpress/plugin-directory/{slug}

One plugin from the WordPress directory.

所有 hosting 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 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)stringThe directory slug, as the search returns it.

响应

名称类型必填内容简介
slugstringThe 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…
namestring
versionstring
authorstringPlain text. The upstream's surrounding anchor markup is stripped.
short_descriptionstring
ratingnumber⛔ **0–5, normalised here.** The upstream reports 0–100; a client rendering that as stars without dividing shows every plugin as full marks.
num_ratingsinteger
active_installsintegerThe 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_updatedstring
requires_wpstringMinimum WordPress version. `""` when the plugin does not say.
requires_phpstringMinimum PHP version. `""` when the plugin does not say.
tested_up_tostringThe newest WordPress the author has tested against.
homepagestring
icon_urlstringThe 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,…
sectionsobjectLong-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