hosting

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

One plugin from the WordPress directory.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

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 GET https://api.zinndigital.com/v1/wordpress/plugin-directory/{slug} \
  -H "Authorization: Bearer zdk_live_…"

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

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`.

Parameter

Name	Typ	Erforderlich	Was es ist
`slug (path)`	`string`	Ja	The directory slug, as the search returns it.

Antwort

Name	Typ	Erforderlich	Was es ist
`slug`	`string`	Ja	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`	Ja	—
`version`	`string`	Ja	—
`author`	`string`	Ja	Plain text. The upstream's surrounding anchor markup is stripped.
`short_description`	`string`	Ja	—
`rating`	`number`	Ja	⛔ 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`	Ja	—
`active_installs`	`integer`	Ja	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`	Ja	—
`requires_wp`	`string`	Ja	Minimum WordPress version. `""` when the plugin does not say.
`requires_php`	`string`	Ja	Minimum PHP version. `""` when the plugin does not say.
`tested_up_to`	`string`	Ja	The newest WordPress the author has tested against.
`homepage`	`string`	Ja	—
`icon_url`	`string`	Ja	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`	Nein	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…

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429 · 503

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