Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/panels/licences/{licenceId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Requires sites.view.

Параметри

НазваТипОбов'язковеЩо це таке
licenceId (path)UuidТакThe licence's id, as listPanelLicences reports it. Ours (UUIDv7).

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_codestringТакThe PanelProduct.code this licence is for.
statestring<pending, active, suspended, released, failed>Такsuspended is not a synonym for released. The charge has stopped and the record has not: the licence returns automatically when the account is back in good standing, with…
target_kindstring<ours, customer>ТакWhose machine this licence runs on. ⛔ Stored rather than derived from whether server_id is set: "did we build this machine" and "whose problem is it when the disk fills" are…
server_idUuidТакOur machine, when there is one. Null for a customer-owned server.
bound_ipstringТакThe address the licence is registered against at the supplier. ⛔ This is what releasing needs — by teardown the machine may be gone, and a licence we cannot release bills monthly…
key_numberstringТакThe panel-facing key number (PLSK.01234567) — an identifier, not a secret. ⛔ The activation code itself is never returned by this API; it lives in Vault.
price_minorintegerТакWhat the customer is charged per month, in minor units, frozen at purchase. A copy rather than a join, so an operator repricing the catalogue cannot move an existing customer's…
currencystringТак
messagestringТакWhy it failed or was suspended, in a sentence the customer reads.
activated_atstringТак

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429