compute
POST /v1/certificates/orders
Start a certificate order. Spends nothing.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա billing.payment.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:
Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
curl -X POST https://api.zinndigital.com/v1/certificates/orders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "product_code": <string>, "common_name": <string>, "currency": <string> }'Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում
Մանրամասներ
⭐ This does NOT buy anything — submit does. The split exists so the refusals a customer can act on arrive while they are still on the screen rather than as a failed background job, and so a half-filled form can never place an order. ⛔ Answers 422 when the product does not cover what was asked for: a wildcard name on a non-wildcard certificate, more domains than the price includes, a term the authority does not sell, or an account not in good standing. Each of those is an order the authority would happily charge for and never issue. Requires billing.payment.manage.
Հարցման մարմին
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
product_code | string | Այո | — |
common_name | string | Այո | The primary domain. A leading *. is a wildcard and is refused on a product that does not cover one — the authority would accept it at order time and refuse it at issuance, after… |
currency | string | Այո | — |
period_years | integer | Ոչ | — |
domains | string[] | Ոչ | Additional names. ⛔ Capped by the product's included_domains — what the price covers — not by what the authority would technically allow, because it bills names beyond the… |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
id | Uuid | Այո | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Այո | The stable machine key (positive_ssl). ⛔ Match on this, never on product_name — the name is the certificate authority's marketing string and can be corrected without the… |
product_name | string | Այո | What the customer reads — the authority's own product name (PositiveSSL, S/MIME Personal, Unified Communications Certificate (UCC)). ⛔ Never a translation key: these are… |
state | string<pending, awaiting_validation, issued, cancelled, failed, expired> | Այո | ⛔⛔ awaiting_validation means PAID AND NOT ISSUED. The authority charges at order time and then waits for the customer to prove they control the domain. It is deliberately… |
common_name | string | Այո | The primary domain on the certificate. |
domains | string[] | Այո | Additional names (SANs). Empty for a single-domain product. |
period_years | integer | Այո | — |
price_minor | integer | Այո | What the customer is charged, frozen at order. A copy rather than a join, so an operator repricing the catalogue cannot move an existing bill. |
currency | string | Այո | — |
validation_instructions | string | Այո | What the customer must still do, in the authority's own words. ⭐ Carried as text rather than parsed: every authority words it differently, and a half-parsed instruction is worse… |
certificate_pem | string | Այո | The issued certificate. ⭐ Public by nature — it is served to every visitor of the site — which is why it is returned here while its private key never is: a customer-generated… |
chain_pem | string | Այո | — |
message | string | Այո | Why it failed or was cancelled, in a sentence the customer reads. |
ordered_at | string | Այո | — |
issued_at | string | Այո | — |
expires_at | string | Այո | — |
days_until_expiry | integer | Այո | Whole days until expires_at, negative once it has lapsed. ⛔ null and 0 are DIFFERENT answers and a client must not collapse them: null means we could not read an expiry… |
renewable | boolean | Այո | Whether to offer a re-order now — issued, inside the 30-day window, and with no renewal already in flight. ⛔ Computed here rather than left to a client to derive from… |
free_alternative_exists | boolean | Այո | Whether Let's Encrypt issues this kind of certificate for nothing. Carried onto the renewal prompt for the same reason it is on the buy screen: say so before asking somebody… |
renewal_of | Uuid | Այո | The order this one renews, so a client can show the chain. |
last_reminded_at | string | Այո | When the renewal sweep last REACHED this order — which is not the same as when it last emailed about it. ⛔ The sweep stamps this for every row it reaches… |
Այս վերջնակետի կողմից վերադարձվող սխալները
401 · 403 · 422 · 429