Mit Guthaben bestellen und bereitstellen

Anfrage, Parameter und Antworten für diesen API-Endpunkt.

POST/api/v1/customer/orders

Überblick

Dieser Endpunkt benötigt einen API-Schlüssel mit Schreibzugriff. Sein Ersteller muss weiterhin der Benutzer des Kundenkontos sein.

Header & Parameter

AuthorizationBearer $SYSTEY_API_KEY · erforderlich

Content-Typeapplication/json

Idempotency-Keyheader · erforderlich

{"type":"string","format":"uuid"}

Neue UUID pro Aktion. Bei Wiederholung dieselbe UUID und denselben Inhalt verwenden.

Anfrage-Body

Senden Sie ein JSON-Objekt. Pflichtfelder beziehen sich auf das jeweilige Objekt. Zusätzlich gelten die fachlichen Voraussetzungen des jeweiligen Endpunkts; unbekannte Felder werden abgewiesen.

Schemafelder und Anforderungen
Feld	Typ	Pflicht
`affiliateCode` default: "" · maxLength: 32	string	—
`couponCode` default: "" · maxLength: 32	string	—
`catalogId` uuid	string	Ja
`catalogVersion` date-time	string	Ja
`paymentMethod` const: "WALLET"	string	Ja
`hostname` default: "" · maxLength: 253	string	—
`sshPublicKey` default: "" · maxLength: 4096	string	—
`accessMethod` "SSH_KEY" \| "PASSWORD" · default: "SSH_KEY"	string	—
`sshKeyId` default: "" · uuid \| ""	string	—
`serverPassword` default: "" · maxLength: 72	string	—
`serverPasswordConfirm` default: "" · maxLength: 72	string	—
`operatingSystemId` default: "" · uuid \| ""	string	—
`domainHandleId` default: "" · uuid \| ""	string	—
`domainSandbox` "true" \| "false"	string	—
`domainAction` "REGISTER" \| "TRANSFER"	string	—
`domainName` default: "" · maxLength: 253	string	—
`domainAuthInfo` default: "" · maxLength: 255	string	—
`domainRegistrantType` "PERSON" \| "ORG" · default: "ORG"	string	—
`domainFirstName` default: "" · maxLength: 100	string	—
`domainLastName` default: "" · maxLength: 100	string	—
`domainEmail` default: "" · maxLength: 254	string	—
`domainPhone` default: "" · maxLength: 30	string	—
`domainCountry` default: "DE" · maxLength: 2	string	—
`domainDnsTemplate` "EMPTY" \| "WEBSITE" \| "GOOGLE_WORKSPACE" \| "MICROSOFT_365" · default: "EMPTY"	string	—
`domainDnsRecords` default: "[]" · maxLength: 100000	string	—
`accepted` const: true	boolean	Ja

Beispielanfrage

Ersetzen Sie Platzhalter durch eigene Werte. Speichern Sie $REQUEST_UUID vor einer schreibenden Aktion, sofern dieser Endpunkt einen Idempotency-Key benötigt.

cURL

curl -i -X POST "https://systey.com/api/v1/customer/orders" \
  -H "Authorization: Bearer $SYSTEY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $REQUEST_UUID" \
  --data '{
  "catalogId": "<offer UUID>",
  "catalogVersion": "<catalogVersion>",
  "paymentMethod": "WALLET",
  "accepted": true,
  "hostname": "mein-server",
  "operatingSystemId": "<OS UUID>",
  "accessMethod": "SSH_KEY",
  "sshPublicKey": "<public SSH key>"
}'

Antwort

HTTP 202

Die Bestellung wurde angenommen. Prüfen Sie den Bestellstatus über die URL im Location-Header. Erst FULFILLED bestätigt die Bereitstellung.

Schemafelder und Anforderungen
Feld	Typ	Pflicht
`data`	object	Ja
`data.id` uuid	string	Ja
`data.number`	integer	Ja
`data.kind` "INITIAL" \| "RENEWAL"	string	Ja
`data.name`	string	Ja
`data.category` "VPS" \| "DOMAIN" \| "WEBSPACE" \| "DEVELOPMENT" \| "MANAGED_SERVICE"	string	Ja
`data.status` "PENDING_PAYMENT" \| "PAID" \| "PROVISIONING" \| "FULFILLED" \| "CANCELLED" \| "REVIEW_REQUIRED"	string	Ja
`data.priceCents`	integer	Ja
`data.setupCents`	integer	Ja
`data.taxCents`	integer	Ja
`data.totalCents`	integer	Ja
`data.billingCycle` "ONCE" \| "MONTHLY" \| "YEARLY"	string	Ja
`data.paymentMethod` "WALLET" \| "MOLLIE"	string	Ja
`data.commercialModel` "CONTRACT" \| "PREPAID"	string	Ja
`data.renewalMode` "NONE" \| "AUTOMATIC" \| "CUSTOMER"	string	Ja
`data.sandbox`	boolean	Ja
`data.createdAt` date-time	string	Ja
`data.paidAt` date-time \| null	string \| null	Ja
`data.fulfilledAt` date-time \| null	string \| null	Ja
`data.product` object \| null	object \| null	Ja
`data.product.id` uuid	string	Ja
`data.payment` object \| null	object \| null	Ja
`data.payment.id` uuid	string	Ja
`data.payment.status`	string	Ja

Fehler

Fehlerantworten enthalten error sowie optional message und details. Rate-Limit: 120 Anfragen pro Minute und Schlüssel. Bei HTTP 429 den Retry-After-Header beachten.