Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/panels/licences/{licenceId} \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Requires `sites.view`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
licenceId (path) | Uuid | Igen | The licence's id, as `listPanelLicences` reports it. Ours (UUIDv7). |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Igen | The `PanelProduct.code` this licence is for. |
state | string<pending, active, suspended, released, failed> | Igen | ⛔ `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_kind | string<ours, customer> | Igen | 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"* a… |
server_id | Uuid | Igen | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | Igen | 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 monthl… |
key_number | string | Igen | 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_minor | integer | Igen | 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… |
currency | string | Igen | — |
message | string | Igen | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429