Request SSL certificate order

This function submits a request for a certificate order to the cPanel Market provider.

SecurityBasicAuth

Request

query Parameters

access_token required	string The access token for the session to the cPanel Market provider. Example: access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05
required	object A JSON-encoded string that contains the details of the certificate. Note: To request multiple certificates, duplicate or increment the parameter name. For example, to request three certificates, use the `certificate` parameter multiple times or use the `certificate-1`, `certificate-2`, and `certificate-3` parameters. Example: certificate={"price":6,"product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]}
provider required	string The cPanel Market provider's name. Example: provider=cPStore
identity_verification	object An object containing the required information for an EV or OV certificate. This information depends on the provider of the certificate. Note: The function returns this object for OV or EV certificate requests. Example: identity_verification={"countryName":"US","duns_number":"12-345-6789","localityName":"City Name","organizationName":"Company, Inc.","organizationalUnitName":"Team Company,","postalCode":55555,"rep_email_address":"username@example.com","rep_forename":"First Name","rep_surname":"Last Name","rep_telephone":"123-456-7891","stateOrProvinceName":"ST","streetAddress":"555 Street Name"}
url_after_checkout	string <url> The URL to send the browser after the user checks out. Note: This URL does not contain a query string. Example: url_after_checkout=http://checkout.example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Market/request_ssl_certificates

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output-jsonpretty --user=username Market request_ssl_certificates access_token='725431a1-d5bc-11e5-a28b-8b0e09a93f05' certificate='{"price":"6","product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]}' provider='cPStore'

Response samples

application/json

{"apiversion": 3,
"func": "request_ssl_certificates",
"module": "Market",
"result": {"data": {"certificates": {"key_id": "ac90f_639fd_6c236062f0d7a4579a30e01612c4cee0",
"order_item_id": 12345
},
"checkout_url": "http://store.example.com/showmethemoney.cgi",
"order_id": 123456
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}