認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ 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.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
product_code | string | はい | — |
currency | string | はい | — |
target_kind | string<ours, customer> | いいえ | — |
server_id | Uuid | いいえ | Required when target_kind is ours. |
bound_ip | string | いいえ | 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… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | はい | The PanelProduct.code this licence is for. |
state | string<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_kind | string<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_id | Uuid | はい | Our machine, when there is one. Null for a customer-owned server. |
bound_ip | string | はい | 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_number | string | はい | 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 | はい | 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 | はい | — |
message | string | はい | Why it failed or was suspended, in a sentence the customer reads. |
activated_at | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 429 · 503