Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/panels/licences \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "product_code": <string>, "currency": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
⛔ **This spends money at the supplier**, monthly, until the licence is released. ⭐ **On the customer's OWN machine the licence is bought immediately**, because the address is known at order time. On one of ours it is recorded `pending` and bought the moment the machine has an IP — Openprovider Plesk licences are IP-bound, and one bought before an address exists is bound to nothing and cannot be released. ⛔ Answers `422` when the account is not in good standing, when the product is not on sale, when a licence for the customer's own server arrives without its IP, or when an extension is ordered for a machine holding no matching base edition. Answers `503` when the supplier could not be reached — in which case the licence is recorded and reconciled automatically rather than silently lost. Requires `billing.payment.manage`.
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
product_code | string | Ano | — |
currency | string | Ano | — |
target_kind | string<ours, customer> | Ne | — |
server_id | Uuid | Ne | Required when `target_kind` is `ours`. |
bound_ip | string | Ne | The machine's IP. ⛔ **Required when `target_kind` is `customer`** and refused rather than defaulted: a licence registered against a guessed address is bound to somebody else's s… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Ano | The `PanelProduct.code` this licence is for. |
state | string<pending, active, suspended, released, failed> | Ano | ⛔ `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> | Ano | 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 | Ano | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | Ano | 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 | Ano | 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 | Ano | 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 | Ano | — |
message | string | Ano | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422 · 429 · 503