Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso sites.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/panels/licences/{licenceId} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Requires `sites.view`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
licenceId (path) | Uuid | Sí | The licence's id, as `listPanelLicences` reports it. Ours (UUIDv7). |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Sí | The `PanelProduct.code` this licence is for. |
state | string<pending, active, suspended, released, failed> | Sí | ⛔ `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> | Sí | 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 | Sí | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | Sí | 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 | Sí | 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 | Sí | 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 | Sí | — |
message | string | Sí | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429