Table of Contents

    API

    Mock Server

    Use this URL to access a mockup of the API server. Your traffic will be recorded and compared to the documentation. You'll find your traffic analysis in the inspector or directly here in the documentation, right next to each resource.

SSL.com API

SSL.com SSL Web Services (SWS) API is a ssl pki management service that allows life-cycle management of ssl certificates.

Please use the following url for testing purposes:
https://sws-test.sslpki.com

SSL Certificates

SSL Certificates related resources of the SSL.com API

Due to a recent change in Baseline requirements, any certificate order (including vouchers) will only be issued up to 39 months (27 for EV) at a time, with the expectation that a replacement certificate with the remaining duration will be issued at the expiration date of the original certificate.

SSL Certificates Collection

Create an SSL Certificate

POST

/certificates

Create an ssl.com certificate order (or voucher code). Upon successful api call, the price (if any) of the ssl certificate will be deducted from reseller account associated with the account number specified in the account_key.

Voucher codes are used to purchase a certificate without having to submit a csr right away. This is useful for host providers, enterprise environments, or any situation where buying the certificate and installating it do not necessarily happen at the same time.

A voucher code can be created by simply only specifying the product type and duration. To process the voucher code at a later time, simply call http://docs.sslcomapi.apiary.io/#put-%2Fcertificate%2F%7Bref%7D and use the voucher code as the ref parameter along with the csr and other information. The first example call (see below) shows how to create a voucher code.

The SSL Certificate request has the following parameters:

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
product

The product code of the ssl certificate being purchased. Select only one code from the following choices:

  • 100 (for EV UCC SSL)

  • 101 (for UCC SSL)

  • 103 (for High Assurance SSL)

  • 102 (for EV SSL)

  • 104 (for Free SSL)

  • 105 (for Wildcard SSL)

  • 106 (for Basic SSL)

  • 107 (for Premium SSL)

integer, required
example: 100
period

The number of days the certificate is valid for. Depending on what is specified by the product key, different options are available:

  • 365 or 730 for EV SSL certs

  • 30 or 90 for Free Trial SSL certs

  • 365, 730, 1095, 1461, or 1826 for all others

integer, required
example: 356
csr

Certificate signing request (Base-64 encoded). If the csr is not provided, then an order voucher will be created instead which can be used at a later time. The voucher code will be returned as result.

text, optional
example: -----BEGIN CERTIFICATE REQUEST-----nMIICvTCCAaUCAQAweDELMAkGA1UEBhMCdXMxDjAMBgNVBAgTBVRleGFzMRAwDgYDnVQQHEwdIb3VzdG9uMRUwEwYDVQQKEwxZb3VyIENvbXBhbnkxFTATBgNVBAsTDFlvndXIgSVQgRGVwdDEZMBcGA1UEAxMQd3d3LnlvdXJzaXRlLmNvbTCCASIwDQYJKoZInhvcNAQEBBQADggEPADCCAQoCggEBAKWnrKf35qmU/tBnieUcQmf0xhntGO2YDgAOnW9J44IAhC1IB715312J28WvoLSSZDuBxqMaLgBbcNyrRFkwbZ+sRbLsjJ24v21DtnLE2gMSbr9YSuH0McOBh9sf23tHd2n5rteJn5fVuxc6ak3t9mag2jjD43Blyh3ih7nADPj0XAk0Gfn+obfmKPMpZwYEhXnJNtWKHzflzAjUjaxbMwMIrvgZcvk/BZZ184znYquasNmvJotvptP0RF3J0GhuiYg75BgimMq3YFxFjAnYjRRZ7p8z/DEfTkdZOPHGnypaz4ny+l8lggyvMOgZD7yanGuVxzlBhpB90INXVDX9+yQ23XHECAwEAAaAAMA0GnCSqGSIb3DQEBBQUAA4IBAQAwbFXORWmD9ovp4qsxozzUZAKxUTluiTIsO+bK2pXVnHAhxVkzcVi8nFqzkeAuKRTQ9UZPMjnnjHWOKIghIpiAabSiC0E/0SPR9s3QzJWhVnOfOpoKYoRnDUh+/SH/Otg4Wid7yKOfdPFK4J8GtnPB2i5Eih0ZOYTTIU2xSmkZ9Tn+LoB7PxOVii8Dq5Nrbbzq8x/WpJfKTackp6nWl2ILcfXM3iGBmLqXPRn5/Uvj767nrq5mHXD2IakxBAeTci16WqQEVcow3qn1JwLyGOzXuuW/UA2/HJUE4zG+8CQIb3OLn0Yq26QKt/i5CJv//uZcRZY8VRkPaH090QOr85UfP7Y3Dn-----END CERTIFICATE REQUEST-----
server_software

The server software which the ssl certificate is to be installed on. This is ignored if the csr parameter is not included.

  • 1 OTHER

  • 2 AOL

  • 3 Apache-ModSSL

  • 4 Apache-SSL (Ben-SSL, not Stronghold)

  • 5 C2Net Stronghold

  • 6 Cisco 3000 Series VPN Concentrator

  • 7 Citrix

  • 8 Cobalt Raq

  • 9 Covalent Server Software

  • 10 Ensim

  • 11 HSphere

  • 12 IBM HTTP Server

  • 13 IBM Internet Connection Server

  • 14 iPlanet

  • 15 Java Web Server (Javasoft / Sun)

  • 16 Lotus Domino

  • 17 Lotus Domino Go!

  • 18 Microsoft IIS 1.x to 4.x

  • 19 Microsoft IIS 5.x to 6.x

  • 20 Microsoft IIS 7.x and later

  • 21 Netscape Enterprise Server

  • 22 Netscape FastTrack

  • 23 Novell Web Server

  • 24 Oracle

  • 25 Plesk

  • 26 Quid Pro Quo

  • 27 R3 SSL Server

  • 28 Raven SSL

  • 29 RedHat Linux

  • 30 SAP Web Application Server

  • 31 Tomcat

  • 32 Website Professional

  • 33 WebStar 4.x and later

  • 34 WebTen (from Tenon)

  • 35 WHM/CPanel

  • 36 Zeus Web Server

  • 37 Nginx

  • 38 Heroku

  • 39 Amazon Load Balancer

integer, optional
example: 1
domains

Domains to be included in the certificate. These values override those listed in the csr. If domains is not specified, the domains for the certificate order will be extracted from the certificate signing request (csr). If you want to use some or all of the domains encoded in the csr along with some additional domains, then you must list all domains in this parameter. The first domain listed in the hash is by default listed in the CN field and the other domains will be listed in the SAN field. Multiple domains can only be listed for the following products: 100, 102, 107. Other product types will only use the first domain and ignore the other domains.

  • dcv The domain control validation method to be performed for a given domain. Valid values for the dcv are:
    • an email address
    • HTTP_CSR_HASH
    • HTTPS_CSR_HASH
    • CNAME_CSR_HASH
hash, optional
example: if csr is specfied: {"domains" : {"www.mysite.com" : {"dcv" : "admin@mysite.com"}}, "mail.domain.io" : {"dcv : "HTTP_CSR_HASH"}}}, or if no csr is specified: "domains" : ["www.mysite.com","*.test.com","mail.yoursite.com"]
organization

Sets the Organization (O) field of the ssl certificate to this value. Ignored for DV certificates. Overrides the (O) value in the csr if csr is specified.

string, required
example: SSL Corp
organization_unit

Sets the Organization Unit (OU) (eg department name). Ignored for DV certificates. Overrides the (OU) value in the csr if csr is specified.

string, optional
example: IT Security
post_office_box

Sets the Post Office Box.

string, optional
street_address_1

Sets the Street Address 1.

string, required
street_address_2

Sets the Street Address 2.

string, optional
street_address_3

Sets the Street Address 3.

string, optional
locality

Set the Locality (eg city or town name). Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
example: Houston
state_or_province

Sets the State or Province. Ignored for DV certificates. Overrides value extracted from the csr.

string, required
example: Texas
postal_code

Sets the Postal Code. Ignored for DV certificates. Overrides value extracted from the csr.

string, required
example: 77098
country

Sets the Country (C) field (ISO3166 2-character country code). Overrides value extracted from the csr.

string, required
example: US
duns_number

Provide the Dun and Bradstreet number which helps validate OV and EV certificates. Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
company_number

Provide the the company registration number which helps validate OV and EV certificates. Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
joi

Jurisdiction of Incorporation. Only for EV certificates.

  • locality The City or Town (if any) in which the company is incorporated or registered.

  • state_or_province The State or Province (if any) in which the company is incorporated or registered.

  • country The Country in which the company is incorporated or registered.

  • incorporation_date The date of incorporation (YYYY-MM-DD) of the company. This is useful information for Validation purposes

  • assumed_name The d/b/a (does business as) name (if any) for the company.

  • business_category Business Category (see Clause 5 of the EV Guidelines V1.0). Valid values are:

    • b Private Organization
    • c Government Entity
    • d Business Entity
hash, optional
example: {"joi" : {"locality" : "Houston", "state_or_province" : "Texas", "country" : "US", "incorporation_date" : "2002-06-01"}, "assumed_name" : "SSL.com", "business_category" : "b"}
ca_certificate_id

If specified, this overrides SSL.com’s default choice of CA certificate/key to be used to issue this certificate. This functionality is only available by special agreement with SSL.com.

integer, optional
external_order_number

This identifier is provided for integration with partner systems. If the external system has a record or identifier that needs to associate with this particular ssl certificate order, then the developer provides an external order number or identifier so that the developer can make the association.

string, optional
hide_certificate_reference

Hide the certificate reference number in the emailed ssl certificate. By default, the ssl certificate reference number is displayed in the email.

  • y hide the certificate reference number in the emailed ssl certificate

  • n default; show the certificate reference number in the emailed ssl certificate

string, optional
contacts

Required only if csr is specified, otherwise contacts will be ignored. Contacts with administrative, billing, technical, validation or all roles. Specify one for each (total of 4): [administrative, billing, technical, validation]. You can also specify one with role all which will used as the default contact in place of one or more of the previous contact roles if they are not specified.

  • title

  • first_name Required

  • last_name Required

  • email Required

  • phone Required

  • ext

  • fax

  • organization

  • organization_unit

  • street_address_1

  • street_address_2

  • street_address_3

  • post_office_box

  • locality

  • state_or_province

  • postal_code

  • country Applicant Representative's country code (ISO3166 2-character country code)

hash, required
example: "contacts":{"all":{"first_name":"Joe","last_name":"Bob","email":"jbob@domain.com","phone":"+123456789","country":"US"}}
app_rep

Applicant Representative used for callback. Only for OV certificates. All values are optional.

  • first_name

  • last_name

  • email_address

  • phone_number

  • title

  • fax

  • organization

  • organization_unit

  • street_address_1

  • street_address_2

  • street_address_3

  • post_office_box

  • locality

  • state_or_province

  • postal_code

  • country Applicant Representative's country code (ISO3166 2-character country code)

  • callback_method Business Category (see Clause 5 of the EV Guidelines V1.0). Valid values are:

    • t The phone_number will be called to communicate a callback verification code which will be used to confirm the identity of the Applicant Representative
    • l A letter, containing a callback verification code, will be sent via snail mail to the Applicant Representative
hash, optional
example: {"app_rep" : {"first_name" : "Joe", "last_name" : "Bob", "email_address" : "bob@mysite.com", "phone_number" : "111-111-1111", "title" : "owner", "country" : "US", "callback_method" : "t"}
payment_method

Optional payment method. If payment method is specified, then payment will override the default method of deducting funds from the prepaid deposit/funded account associated with the account_key.

  • credit_card
    • first_name Required
    • last_name Required
    • number Required
    • expires Required
    • cvv Required
    • street_address_1
    • street_address_2
    • street_address_3
    • post_office_box
    • locality
    • state_or_province
    • postal_code Required
    • country Applicant Representative's country code (ISO3166 2-character country code)
hash, optional
example: "payment":{"credit_card":{"first_name":"Bob","last_name":"Smith","number":"370000000000002","expires":"0119","cvv":"007,"postal_code":"77098","country":"US"}}

Response

201 (Created)
Content-Type: application/json
{"ref":"co-0c1aeum4p","registrant":null,"order_status":"unused. waiting on certificate signing request (csr) from customer","validations":null,"order_amount":"$0.00","certificate_url":"https://www.ssl.com/certificate_orders/co-0c1aeum4p","receipt_url":"https://www.ssl.com/orders/1f5d-1aeum4p","smart_seal_url":"https://www.ssl.com/certificate_orders/co-0c1aeum4p/site_seal","validation_url":"https://www.ssl.com/certificate_orders/co-0c1aeum4p/validation"}

Response

201 (Created)
Content-Type: application/json
{"ref":"co-721aea5ls","registrant":{"organization":"yoursite","organization_unit":"yourname","street_address_1":"somewhere st","street_address_2":null,"street_address_3":null,"locality":"Houston","state_or_province":"Texas","post_office_box":null,"postal_code":"77777","country":"US"},"order_status":"waiting on validation from customer","validations":null,"order_amount":"$399.00","certificate_url":"https://www.ssl.com/certificate_orders/co-721aea5ls","receipt_url":"https://www.ssl.com/orders/ffdc-1aea5ls","smart_seal_url":"https://www.ssl.com/certificate_orders/co-721aea5ls/site_seal","validation_url":"https://www.ssl.com/certificate_orders/co-721aea5ls/validation"}

SSL Certificates Collection

List all SSL Certificates

GET

/certificates{?account_key,secret_key,start,end}

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
start

Beginning of date range when the certificate orders were created.

string, optional
example: 01-31-2012
end

Ending of date range when the certificate orders were created. If not specified then defaults to now.

string, optional
example: 04-30-2015
filter

Filter the result set. Currently vouchers is supported and only returns unused available certificate order credits. If this parameter is not specified all certificate orders are returned.

string, optional
example: vouchers

Response

200 (OK)
Content-Type: application/json
[{"ref":"co-f57bk3f2k","description":"1 Year Multi-domain UCC SSL","order_status":"unused. waiting on certificate signing request (csr) from customer",,"order_date":"2015-04-29T00:23:32-05:00","registrant":null,"certificates":null,"common_name":null,"domains_qty_purchased":"4","wildcard_qty_purchased":"1","subject_alternative_names":null,"validations":null,"effective_date":null,"expiration_date":null,"algorithm":null,"domains":["mail.mysite.com","www.domain.com","*.domain.com","autodiscover.mysite.com"],"site_seal_code":null},{"ref":"co-0c1aj18j5","description":"1 Year Basic SSL","order_status":"waiting validation email response from customer", "order_date":"2015-04-17T01:04:22-05:00","registrant":{"organization":"Acme Inc","organization_unit":null,"street_address_1":"123 Acme Ln","street_address_2":null,"street_address_3":null,"locality":"Houston","state_or_province":"Texas","post_office_box":null,"postal_code":"77098","country":"US"},"certificates":null,"common_name":null,"domains_qty_purchased":"1","wildcard_qty_purchased":"0","subject_alternative_names":null,"validations":{"www.acme.com":{"attempted_on":"2015-04-17T01:04:22-05:00","dcv_method":"admin@acme.com","status":"not yet available"}},"effective_date":null,"expiration_date":null,"algorithm":null,"domains":["www.acme.com"],"site_seal_code":null},{"ref":"co-9a1aiv007","description":"1 Year Basic SSL","order_status":"waiting validation email response from customer","order_date":"2015-04-20T00:55:11-05:00","registrant":{"organization":"Tampa Cigars","organization_unit":null,"street_address_1":"123 Street","street_address_2":null,"street_address_3":null,"locality":"Tampa","state_or_province":"Florida","post_office_box":null,"postal_code":"99909","country":"US"},"certificates":null,"common_name":null,"domains_qty_purchased":"1","wildcard_qty_purchased":"0","subject_alternative_names":null,"validations":{"www.coolsite.com":{"attempted_on":"2015-04-20T00:55:11-05:00","dcv_method":"admin@coolsite.com","status":"not yet available"}},"effective_date":null,"expiration_date":null,"algorithm":null,"domains":["www.coolsite.com"],"site_seal_code":null}]

SSL Certificate

A single Certificate object with all its details

Retrieve an SSL Certificate

GET

/certificate/{ref}/{?account_key,secret_key,query_type,response_type,response_encoding}

Parameters
Name Description Details
ref

String ref is the certificate reference number (or voucher code) of the SSL.com certificate order.

string, required
example: co-abcd1234
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
query_type

Specifies what should be returned. order_status will always be returned, and certificates will be returned with key certificates if applicable. Default: order_status_only

  • order_status_only

  • end_certificate

  • all_certificates

  • ca_bundle

string, optional
example: order_status_only
response_type

Specifies the type/format of the certificates that are being returned, if applicable. Default: individually

  • zip

  • netscape

  • pkcs7

  • individually

string, optional
example: individually
response_encoding

Specifies the encoding of the certificates that are being returned, if applicable. Default: base64

  • base64

  • binary

string, optional
example: base64

Response

200 (OK)
Content-Type: application/json
{"description":"1 Year Multi-Domain UCC SSL","order_date":"2015-01-22T15:49:31-05:00","product":"101","domains_qty_purchased":"4","wildcard_qty_purchased":"1","order_status":"issued","registrant":{"organization":"INBS","organization_unit":"yoursite","street_address_1":"somewhere st","street_address_2":null,"street_address_3":null,"locality":"Houston","state_or_province":"Texas","post_office_box":null,"postal_code":"77777","country":"US"},"certificates":"-----BEGIN CERTIFICATE-----\r\nMIIE1TCCA72gAwIBAgIRANsjhF+tHggE1QEZiYQRu+0wDQYJKoZIhvcNAQELBQAw\r\nTTELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB1NTTC5jb20xFDASBgNVBAsTC3d3dy5z\r\nc2wuY29tMRYwFAYDVQQDEw1TU0wuY29tIERWIENBMB4XDTE1MDIxMTAwMDAwMFoX\r\nDTE2MDEyNzIzNTk1OVowYzEhMB8GA1UECxMYRG9tYWluIENvbnRyb2wgVmFsaWRh\r\ndGVkMSEwHwYDVQQLExhQb3NpdGl2ZVNTTCBNdWx0aS1Eb21haW4xGzAZBgNVBAMT\r\nEnRlc3Q4Lm1nLXRlc3QyLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\r\nggEBAPDXU+QGXwRoxkteeK5P0IHYADRsJ3xpYMAe4PxDloJLmabwLkd1wUTi948g\r\n7HUZ//T5wuWz1KeCg39cYLYnb0wj8pdFizvHtE0+GwrsyMk/hRWTDSfnw+lWX2Bw\r\nEmn1QI5rQZHZLMS3AbofTbHjXmy0de7XyFMEdVruMFEXV++I2gZbnqaTSWT9kRZd\r\nbTQ3PBDKYMQKyqn0JQv9TyHCyTGmCxEwhBNqh3o4lwBtpZOW7QzWC4KTrBnaMZRC\r\ndhzqj/xB7f/G2PObQavlaZehRRARBMUeyd3gEg+Tk7aJ1rlyXpjDp7AHgsuC9m/c\r\nwiUy4uFQTsyYweWK6eltOzy6sxkCAwEAAaOCAZgwggGUMB8GA1UdIwQYMBaAFEaa\r\n/fxRXnxUU1LimeOzMu+TGn9WMB0GA1UdDgQWBBRzPdGuZ0OXyuDQVLMKNFegy0VT\r\nyDAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/BAIwADAdBgNVHSUEFjAUBggrBgEF\r\nBQcDAQYIKwYBBQUHAwIwSgYDVR0gBEMwQTA1BgorBgEEAYKpMAEBMCcwJQYIKwYB\r\nBQUHAgEWGWh0dHBzOi8vY3BzLnVzZXJ0cnVzdC5jb20wCAYGZ4EMAQIBMDQGA1Ud\r\nHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuc3NsLmNvbS9TU0xjb21EVkNBXzIuY3Js\r\nMGAGCCsGAQUFBwEBBFQwUjAvBggrBgEFBQcwAoYjaHR0cDovL2NydC5zc2wuY29t\r\nL1NTTGNvbURWQ0FfMi5jcnQwHwYIKwYBBQUHMAGGE2h0dHA6Ly9vY3NwLnNzbC5j\r\nb20wMQYDVR0RBCowKIISdGVzdDgubWctdGVzdDIuY29tghJ0ZXN0OS5tZy10ZXN0\r\nMi5jb20wDQYJKoZIhvcNAQELBQADggEBAIlDmCQmj3F2sYIJsQuP4B05+hGS5oYt\r\nlWphG1kwTnsXeqkyZsSoIzBPT/LkeYmA7AlRtWQjQ7xdvnjV12cFVTs/Fxbzzz4Z\r\nIrlMCChzDPRAhiMhCjMtIhNdSf+1h6Kgsgix3AjN9aaZmbtkp6dyA93oT4e0mSk7\r\n3cHUzV/gQUe2W2l1KoyRv+vrUcByU4lHFc9X0qpV1heZqcCjEOde7lIQzvIwVwRh\r\nwMfQ0jgT8SZw9STAczk6tUJ5+fd+J7R5vvULFlLap0LeyA9OsxHCUV3UZpms1J84\r\nN2ghEOtJDDaMypID014bY4ly52Pxe2gc3e/88bnlARUOBXLViZO43c0=\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIFdzCCBF+gAwIBAgIQE+oocFv07O0MNmMJgGFDNjANBgkqhkiG9w0BAQwFADBv\r\nMQswCQYDVQQGEwJTRTEUMBIGA1UEChMLQWRkVHJ1c3QgQUIxJjAkBgNVBAsTHUFk\r\nZFRydXN0IEV4dGVybmFsIFRUUCBOZXR3b3JrMSIwIAYDVQQDExlBZGRUcnVzdCBF\r\neHRlcm5hbCBDQSBSb290MB4XDTAwMDUzMDEwNDgzOFoXDTIwMDUzMDEwNDgzOFow\r\ngYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpOZXcgSmVyc2V5MRQwEgYDVQQHEwtK\r\nZXJzZXkgQ2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMS4wLAYD\r\nVQQDEyVVU0VSVHJ1c3QgUlNBIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIICIjAN\r\nBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAgBJlFzYOw9sIs9CsVw127c0n00yt\r\nUINh4qogTQktZAnczomfzD2p7PbPwdzx07HWezcoEStH2jnGvDoZtF+mvX2do2NC\r\ntnbyqTsrkfjib9DsFiCQCT7i6HTJGLSR1GJk23+jBvGIGGqQIjy8/hPwhxR79uQf\r\njtTkUcYRZ0YIUcuGFFQ/vDP+fmyc/xadGL1RjjWmp2bIcmfbIWax1Jt4A8BQOujM\r\n8Ny8nkz+rwWWNR9XWrf/zvk9tyy29lTdyOcSOk2uTIq3XJq0tyA9yn8iNK5+O2hm\r\nAUTnAU5GU5szYPeUvlM3kHND8zLDU+/bqv50TmnHa4xgk97Exwzf4TKuzJM7UXiV\r\nZ4vuPVb+DNBpDxsP8yUmazNt925H+nND5X4OpWaxKXwyhGNVicQNwZNUMBkTrNN9\r\nN6frXTpsNVzbQdcS2qlJC9/YgIoJk2KOtWbPJYjNhLixP6Q5D9kCnusSTJV882sF\r\nqV4Wg8y4Z+LoE53MW4LTTLPtW//e5XOsIzstAL81VXQJSdhJWBp/kjbmUZIO8yZ9\r\nHE0XvMnsQybQv0FfQKlERPSZ51eHnlAfV1SoPv10Yy+xUGUJ5lhCLkMaTLTwJUdZ\r\n+gQek9QmRkpQgbLevni3/GcV4clXhB4PY9bpYrrWX1Uu6lzGKAgEJTm4Diup8kyX\r\nHAc/DVL17e8vgg8CAwEAAaOB9DCB8TAfBgNVHSMEGDAWgBStvZh6NLQm9/rEJlTv\r\nA73gJMtUGjAdBgNVHQ4EFgQUU3m/WqorSs9UgOHYm8Cd8rIDZsswDgYDVR0PAQH/\r\nBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wEQYDVR0gBAowCDAGBgRVHSAAMEQGA1Ud\r\nHwQ9MDswOaA3oDWGM2h0dHA6Ly9jcmwudXNlcnRydXN0LmNvbS9BZGRUcnVzdEV4\r\ndGVybmFsQ0FSb290LmNybDA1BggrBgEFBQcBAQQpMCcwJQYIKwYBBQUHMAGGGWh0\r\ndHA6Ly9vY3NwLnVzZXJ0cnVzdC5jb20wDQYJKoZIhvcNAQEMBQADggEBAJNl9jeD\r\nlQ9ew4IcH9Z35zyKwKoJ8OkLJvHgwmp1ocd5yblSYMgpEg7wrQPWCcR23+WmgZWn\r\nRtqCV6mVksW2jwMibDN3wXsyF24HzloUQToFJBv2FAY7qCUkDrvMKnXduXBBP3zQ\r\nYzYhBx9G/2CkkeFnvN4ffhkUyWNnkepnB2u0j4vAbkN9w6GAbLIevFOFfdyQoaS8\r\nLe9Gclc1Bb+7RrtubTeZtv8jkpHGbkD4jylW6l/VXxRTrPBPYer3IsynVgviuDQf\r\nJtl7GQVoP7o81DgGotPmjw7jtHFtQELFhLRAlSv0ZaBIefYdgWOWnU914Ph85I6p\r\n0fKtirOMxyHNwu8=\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIF5jCCA86gAwIBAgIQEQDFvydYwZlp/Gjtcp381zANBgkqhkiG9w0BAQwFADCB\r\niDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0pl\r\ncnNleSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNV\r\nBAMTJVVTRVJUcnVzdCBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTQw\r\nNzA0MDAwMDAwWhcNMjQwNzAzMjM1OTU5WjBNMQswCQYDVQQGEwJVUzEQMA4GA1UE\r\nChMHU1NMLmNvbTEUMBIGA1UECxMLd3d3LnNzbC5jb20xFjAUBgNVBAMTDVNTTC5j\r\nb20gRFYgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDAJEcVY7NR\r\n2qmRMLzC17tObKov3Jf1AQLOfZRfCi26JM4lYzJoW7uMO6RSwBJeP6pSBYthSWLc\r\nR+zd0bsQW5xKGITX51HYBH3daGWQEJIWVfL59cw3qhRsMQ5XP/IMZ15BOUxqGRVV\r\n7NnCBBVcrWVhrEqSZbM6o61lMBU3sQQlYep/Ie3Ce6ca8oWfX5h4hrWtxuRCiBB4\r\nEjxMB5KYOKJnQaOLEXaRhgr8cNHhzjl2KrKx/tCMtR/9pqy/+dOCKDiQWkg+hBoT\r\nD/hGc/B3x7KfHAbdLJTPrRdJrFnSwMWwPcrWGIrrud3w5VxzXBjPAzQn7Dg/hpGB\r\nNHEHBwKsLER3AgMBAAGjggGEMIIBgDAfBgNVHSMEGDAWgBRTeb9aqitKz1SA4dib\r\nwJ3ysgNmyzAdBgNVHQ4EFgQURpr9/FFefFRTUuKZ47My75Maf1YwDgYDVR0PAQH/\r\nBAQDAgGGMBIGA1UdEwEB/wQIMAYBAf8CAQAwHQYDVR0lBBYwFAYIKwYBBQUHAwEG\r\nCCsGAQUFBwMCMCEGA1UdIAQaMBgwDAYKKwYBBAGCqTABATAIBgZngQwBAgEwVQYD\r\nVR0fBE4wTDBKoEigRoZEaHR0cDovL2NybC50cnVzdC1wcm92aWRlci5jb20vVVNF\r\nUlRydXN0UlNBQ2VydGlmaWNhdGlvbkF1dGhvcml0eS5jcmwwgYAGCCsGAQUFBwEB\r\nBHQwcjBEBggrBgEFBQcwAoY4aHR0cDovL2NydC50cnVzdC1wcm92aWRlci5jb20v\r\nVVNFUlRydXN0UlNBQWRkVHJ1c3RDQS5jcnQwKgYIKwYBBQUHMAGGHmh0dHA6Ly9v\r\nY3NwLnRydXN0LXByb3ZpZGVyLmNvbTANBgkqhkiG9w0BAQwFAAOCAgEAB1RJZUdF\r\nd05ZN1SYdTZsDj9Rq9De097SCCWi0E97Ehc2MRQag98VqlZPrC2WM9q+C7Z5MvcM\r\n1njs15p55YRJbHjjECgiabKEPsx3xXH+oTb4kKzQjqMZV5CNC7K+5H4OaCtNcFEZ\r\nE2vWRI9hunFjTfTJ9VrKjGIwcYz30VtdB1vtk0Jaf0lnC4H1GOAdw3IwJgbygOeu\r\nACY/1RH5U0ai2e9wWXsiADjBtHbiFPEzt5Cmu2wag9fPrX663Xs5TqjDNCPAgCLm\r\nijzyrCQmlCaug332cwnYI5dA0Oa/eIV6lYZTev143bZWs+A6dQhXDJUQzfSvPsQS\r\nPu/W3QAkw4vuZ97mVvgzK5LiDWps2N9Fw9b5Et4Op+cuy27I48fG3bRH0dROJwYs\r\nw+MrMc5Sy/TOl9a5UUmtq2jEJbEv7xU5x1bvhaFfBtxoF36sLLuPf19Aev4n2Y46\r\nFou4Aup1eWVyS+XYKiaTGzxL5b4fbwhKItk8NptdrJ26YmdCl6cFNaabXHHak24W\r\nI0cF4+u8ATOxkdFkuLyWusWzfmfIMHX1ZHD3giYavooNnupzxnju58Tpc9AsCgyL\r\nrRxTbur5AscjOsHHfzeeTqflKtslTvJ9AvNkPLizR2cMk4+1h+6yDBHggsm0bZn0\r\nAeY5kXGfjIimFcd00xvjkVn41em3We1sghs=\r\n-----END CERTIFICATE-----\r\n","common_name":"test8.mg-test2.com","subject_alternative_names":["test8.mg-test2.com","test9.mg-test2.com"],"validations":{"test8.mg-test2.com":{"attempted_on":"2015-02-16T08:26:56-06:00","dcv_method":"http_csr_hash","status":"not yet available"},"test9.mg-test2.com":{"attempted_on":"2015-02-16T08:26:56-06:00","dcv_method":"http_csr_hash","status":"not yet available"}},"effective_date":"2015-02-10T18:00:00-06:00","expiration_date":"2016-01-27T17:59:59-06:00","algorithm":"SHA256","domains":null,"site_seal_code":"\\u003Ca href=http://www.sslpki.com/site_seals/d604b472-54e1fd5f/site_report onclick=window.open(\\u0026#x27;http://www.sslpki.com/site_seals/d604b472-54e1fd5f/site_report\\u0026#x27;, \\u0026#x27;site_report\\u0026#x27;,\\u0026#x27;height=500, width=400, top=100, left=100\\u0026#x27;); return false; onmouseover=this.style.cursor=\\u0026#x27;pointer\\u0026#x27; style=border: none;\\u003E\\u003Cimg alt=Ssl_seal_1_ev src=http://sws-test.sslpki.com/images/ssl_seal_1_ev.png width=130px /\\u003E\\u003C/a\\u003E\n"}

SSL Certificate

Process, rekey, update validation of an SSL Certificate order

PUT

/certificate/{ref}

Use this call to process a voucher, rekey an existing certificate order, or change the validation method(s).

To process a voucher, simply provide the voucher code (ref) along with the csr and other relevant information for the certificate order. This also applies to a certificate that has already been processed but needs to be rekeyed.

To change the validation methods, simply provide the voucher or certificate reference number (ref) and the domains parameter. The other "required" parameters are not required if doing the update validation call.

Parameters
Name Description Details
ref

String ref is the certificate reference number (or voucher code) of the SSL.com certificate order. You specify this in the url so there is no need to include it as a parameter in the JSON request.

string, required
example: co-abcd1234
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
csr

Certificate signing request (Base-64 encoded).

text, required
example: -----BEGIN CERTIFICATE REQUEST-----nMIICvTCCAaUCAQAweDELMAkGA1UEBhMCdXMxDjAMBgNVBAgTBVRleGFzMRAwDgYDnVQQHEwdIb3VzdG9uMRUwEwYDVQQKEwxZb3VyIENvbXBhbnkxFTATBgNVBAsTDFlvndXIgSVQgRGVwdDEZMBcGA1UEAxMQd3d3LnlvdXJzaXRlLmNvbTCCASIwDQYJKoZInhvcNAQEBBQADggEPADCCAQoCggEBAKWnrKf35qmU/tBnieUcQmf0xhntGO2YDgAOnW9J44IAhC1IB715312J28WvoLSSZDuBxqMaLgBbcNyrRFkwbZ+sRbLsjJ24v21DtnLE2gMSbr9YSuH0McOBh9sf23tHd2n5rteJn5fVuxc6ak3t9mag2jjD43Blyh3ih7nADPj0XAk0Gfn+obfmKPMpZwYEhXnJNtWKHzflzAjUjaxbMwMIrvgZcvk/BZZ184znYquasNmvJotvptP0RF3J0GhuiYg75BgimMq3YFxFjAnYjRRZ7p8z/DEfTkdZOPHGnypaz4ny+l8lggyvMOgZD7yanGuVxzlBhpB90INXVDX9+yQ23XHECAwEAAaAAMA0GnCSqGSIb3DQEBBQUAA4IBAQAwbFXORWmD9ovp4qsxozzUZAKxUTluiTIsO+bK2pXVnHAhxVkzcVi8nFqzkeAuKRTQ9UZPMjnnjHWOKIghIpiAabSiC0E/0SPR9s3QzJWhVnOfOpoKYoRnDUh+/SH/Otg4Wid7yKOfdPFK4J8GtnPB2i5Eih0ZOYTTIU2xSmkZ9Tn+LoB7PxOVii8Dq5Nrbbzq8x/WpJfKTackp6nWl2ILcfXM3iGBmLqXPRn5/Uvj767nrq5mHXD2IakxBAeTci16WqQEVcow3qn1JwLyGOzXuuW/UA2/HJUE4zG+8CQIb3OLn0Yq26QKt/i5CJv//uZcRZY8VRkPaH090QOr85UfP7Y3Dn-----END CERTIFICATE REQUEST-----
server_software

The server software which the ssl certificate is to be installed on.

  • 1 OTHER

  • 2 AOL

  • 3 Apache-ModSSL

  • 4 Apache-SSL (Ben-SSL, not Stronghold)

  • 5 C2Net Stronghold

  • 6 Cisco 3000 Series VPN Concentrator

  • 7 Citrix

  • 8 Cobalt Raq

  • 9 Covalent Server Software

  • 10 Ensim

  • 11 HSphere

  • 12 IBM HTTP Server

  • 13 IBM Internet Connection Server

  • 14 iPlanet

  • 15 Java Web Server (Javasoft / Sun)

  • 16 Lotus Domino

  • 17 Lotus Domino Go!

  • 18 Microsoft IIS 1.x to 4.x

  • 19 Microsoft IIS 5.x to 6.x

  • 20 Microsoft IIS 7.x and later

  • 21 Netscape Enterprise Server

  • 22 Netscape FastTrack

  • 23 Novell Web Server

  • 24 Oracle

  • 25 Plesk

  • 26 Quid Pro Quo

  • 27 R3 SSL Server

  • 28 Raven SSL

  • 29 RedHat Linux

  • 30 SAP Web Application Server

  • 31 Tomcat

  • 32 Website Professional

  • 33 WebStar 4.x and later

  • 34 WebTen (from Tenon)

  • 35 WHM/CPanel

  • 36 Zeus Web Server

  • 37 Nginx

  • 38 Heroku

  • 39 Amazon Load Balancer

integer, required
example: 1
domains

Domains to be included in the certificate. These values override those listed in the csr. If domains is not specified, the domains for the certificate order will be extracted from the certificate signing request (csr). If you want to use some or all of the domains encoded in the csr along with some additional domains, then you must list all domains in this parameter. The first domain listed in the hash is by default listed in the CN field and the other domains will be listed in the SAN field. Multiple domains can only be listed for the following products: 100, 102, 107. Other product types will only use the first domain and ignore the other domains.

  • dcv The domain control validation method to be performed for a given domain. Valid values for the dcv are:
    • an email address
    • HTTP_CSR_HASH
    • HTTPS_CSR_HASH
    • CNAME_CSR_HASH
hash, optional
example: {"domains" : {"www.mysite.com" : {"dcv" : "admin@mysite.com"}}, "mail.domain.io" : {"dcv : "HTTP_CSR_HASH"}}}
organization

Sets the Organization (O) field of the ssl certificate to this value. Ignored for DV certificates. Overrides the (O) value in the csr if csr is specified.

string, required
example: SSL Corp
organization_unit

Sets the Organization Unit (OU) (eg department name). Ignored for DV certificates. Overrides the (OU) value in the csr if csr is specified.

string, optional
example: IT Security
post_office_box

Sets the Post Office Box.

string, optional
street_address_1

Sets the Street Address 1.

string, required
street_address_2

Sets the Street Address 2.

string, optional
street_address_3

Sets the Street Address 3.

string, optional
locality

Set the Locality (eg city or town name). Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
example: Houston
state_or_province

Sets the State or Province. Ignored for DV certificates. Overrides value extracted from the csr.

string, required
example: Texas
postal_code

Sets the Postal Code. Ignored for DV certificates. Overrides value extracted from the csr.

string, required
example: 77098
country

Sets the Country (C) field (ISO3166 2-character country code). Overrides value extracted from the csr.

string, required
example: US
duns_number

Provide the Dun and Bradstreet number which helps validate OV and EV certificates. Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
company_number

Provide the the company registration number which helps validate OV and EV certificates. Ignored for DV certificates. Overrides value extracted from the csr.

string, optional
joi

Jurisdiction of Incorporation. Only for EV certificates.

  • locality The City or Town (if any) in which the company is incorporated or registered.

  • state_or_province The State or Province (if any) in which the company is incorporated or registered.

  • country The Country in which the company is incorporated or registered.

  • incorporation_date The date of incorporation (YYYY-MM-DD) of the company. This is useful information for Validation purposes

  • assumed_name The d/b/a (does business as) name (if any) for the company.

  • business_category Business Category (see Clause 5 of the EV Guidelines V1.0). Valid values are:

    • b Private Organization
    • c Government Entity
    • d Business Entity
hash, optional
example: {"joi" : {"locality" : "Houston", "state_or_province" : "Texas", "country" : "US", "incorporation_date" : "2002-06-01"}, "assumed_name" : "SSL.com", "business_category" : "b"}
ca_certificate_id

If specified, this overrides SSL.com’s default choice of CA certificate/key to be used to issue this certificate. This functionality is only available by special agreement with SSL.com.

integer, optional
external_order_number

This identifier is provided for integration with partner systems. If the external system has a record or identifier that needs to associate with this particular ssl certificate order, then the developer provides an external order number or identifier so that the developer can make the association.

string, optional
hide_certificate_reference

Hide the certificate reference number in the emailed ssl certificate. By default, the ssl certificate reference number is displayed in the email.

  • y hide the certificate reference number in the emailed ssl certificate

  • n default; show the certificate reference number in the emailed ssl certificate

string, optional
contacts

Contacts with administrative, billing, technical, validation or all roles. Specify one for each (total of 4): [administrative, billing, technical, validation]. You can also specify one with role all which will used as the default contact in place of one or more of the previous contact roles if they are not specified.

  • title

  • first_name Required

  • last_name Required

  • email Required

  • phone Required

  • ext

  • fax

  • organization

  • organization_unit

  • street_address_1

  • street_address_2

  • street_address_3

  • post_office_box

  • locality

  • state_or_province

  • postal_code

  • country Applicant Representative's country code (ISO3166 2-character country code)

hash, required
example: "contacts":{"all":{"first_name":"Joe","last_name":"Bob","email":"jbob@domain.com","phone":"+123456789","country":"US"}}
app_rep

Applicant Representative used for callback. Only for OV certificates. All values are optional.

  • first_name

  • last_name

  • email_address

  • phone_number

  • title

  • fax

  • organization

  • organization_unit

  • street_address_1

  • street_address_2

  • street_address_3

  • post_office_box

  • locality

  • state_or_province

  • country Applicant Representative's country code (ISO3166 2-character country code)

  • callback_method Business Category (see Clause 5 of the EV Guidelines V1.0). Valid values are:

    • t The phone_number will be called to communicate a callback verification code which will be used to confirm the identity of the Applicant Representative
    • l A letter, containing a callback verification code, will be sent via snail mail to the Applicant Representative
hash, optional
example: {"app_rep" : {"first_name" : "Joe", "last_name" : "Bob", "email_address" : "bob@mysite.com", "phone_number" : "111-111-1111", "title" : "owner", "country" : "US", "callback_mathod" : "t"}

Response

200 (OK)
Content-Type: application/json
{"ref":"co-b62bk3f12","registrant":{"organization":"Solutions Inc","organization_unit":null,"street_address_1":"123 Main St","street_address_2":null,"street_address_3":null,"locality":"Austin","state_or_province":"Texas","post_office_box":null,"postal_code":"160030","country":"US"},"order_status":"validating, please wait","validations":null,"order_amount":"$306.00","certificate_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12","receipt_url":"https://www.ssl.com/orders/676d-1ak3f12","smart_seal_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12/site_seal","validation_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12/validation"}

Response

200 (OK)
Content-Type: application/json
{"ref":"co-b62bk3f12","registrant":{"organization":"Solutions Inc","organization_unit":null,"street_address_1":"123 Main St","street_address_2":null,"street_address_3":null,"locality":"Austin","state_or_province":"Texas","post_office_box":null,"postal_code":"160030","country":"US"},"order_status":"validating, please wait","validations":null,"order_amount":"$306.00","certificate_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12","receipt_url":"https://www.ssl.com/orders/676d-1ak3f12","smart_seal_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12/site_seal","validation_url":"https://www.ssl.com/certificate_orders/co-b62bk3f12/validation"}

Revoke an SSL Certificate

DELETE

/certificate/{ref}

Response

204 (No Content)

SSL Certificate Validation

A single Validation object containing a list of acceptable methods to complete the verification of the order.

Retrieve acceptable domain validation methods for Certificate

GET

/certificate/{ref}/validations/methods{?account_key,secret_key}

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
ref

String ref is the certificate reference number (or voucher code) of the SSL.com certificate order. Has example value.

string, required
example: co-xxxx

Response

200 (OK)
Content-Type: application/json
{"instructions":"https://support.ssl.com/Knowledgebase/Article/View/29/0/alternative-methods-of-domain-control-validation-dcv","md5_hash":"FCC429296A9B86FBF296C853138D707B","sha1_hash":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8","dcv_methods":{"www.test4.com":{"email_addresses":["domain.privacy.services.ltd@gmail.com","webmaster@test4.com","postmaster@test4.com","hostmaster@test4.com","administrator@test4.com","admin@test4.com","webmaster@www.test4.com","postmaster@www.test4.com","hostmaster@www.test4.com","administrator@www.test4.com","admin@www.test4.com"],"http_csr_hash":{"http":"http://www.test4.com/FCC429296A9B86FBF296C853138D707B.txt","allow_https":"true","contents":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8\ncomodoca.com"},"cname_csr_hash":{"cname":"FCC429296A9B86FBF296C853138D707B.www.test4.com. CNAME B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com.","name":"FCC429296A9B86FBF296C853138D707B.www.test4.com","value":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com."}},"www.abc.de":{"email_addresses":["noc@work.de","webmaster@abc.de","postmaster@abc.de","hostmaster@abc.de","administrator@abc.de","admin@abc.de","webmaster@www.abc.de","postmaster@www.abc.de","hostmaster@www.abc.de","administrator@www.abc.de","admin@www.abc.de"],"http_csr_hash":{"http":"http://www.abc.de/FCC429296A9B86FBF296C853138D707B.txt","allow_https":"true","contents":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8\ncomodoca.com"},"cname_csr_hash":{"cname":"FCC429296A9B86FBF296C853138D707B.www.abc.de. CNAME B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com.","name":"FCC429296A9B86FBF296C853138D707B.www.abc.de","value":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com."}}}}

Email Validation Options

A single Validation object containing a list of acceptable email addresses for domain control control validation of an ssl certificate.

Retrieve acceptable email addresses for domain control validation

GET

/certificates/validations/email{?account_key,secret_key,domains}

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
domains[]=

Array of 1 or more domains to query. Each value must be separated out with a name domains[], ie domains[]=www.domain.com&domains[]=domain2.info&domains[]=mail.domain3.biz

string, required
example: www.domain1.com

Response

200 (OK)
Content-Type: application/json
X-My-Header: The Value
{ "id": 2, "title": "Pick-up posters from post-office" }

CSR Hash Validation Options

A single Validation object containing values that will satisfy domain control validation using the hash of the certificate signing request.

Retrieve all validation methods based on hash of certificate signing request

POST

/certificates/validations/csr_hash

The Validations request has the following parameters:

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
csr

Certificate signing request (Base-64 encoded).

text, required
example: -----BEGIN CERTIFICATE REQUEST-----nMIICvTCCAaUCAQAweDELMAkGA1UEBhMCdXMxDjAMBgNVBAgTBVRleGFzMRAwDgYDnVQQHEwdIb3VzdG9uMRUwEwYDVQQKEwxZb3VyIENvbXBhbnkxFTATBgNVBAsTDFlvndXIgSVQgRGVwdDEZMBcGA1UEAxMQd3d3LnlvdXJzaXRlLmNvbTCCASIwDQYJKoZInhvcNAQEBBQADggEPADCCAQoCggEBAKWnrKf35qmU/tBnieUcQmf0xhntGO2YDgAOnW9J44IAhC1IB715312J28WvoLSSZDuBxqMaLgBbcNyrRFkwbZ+sRbLsjJ24v21DtnLE2gMSbr9YSuH0McOBh9sf23tHd2n5rteJn5fVuxc6ak3t9mag2jjD43Blyh3ih7nADPj0XAk0Gfn+obfmKPMpZwYEhXnJNtWKHzflzAjUjaxbMwMIrvgZcvk/BZZ184znYquasNmvJotvptP0RF3J0GhuiYg75BgimMq3YFxFjAnYjRRZ7p8z/DEfTkdZOPHGnypaz4ny+l8lggyvMOgZD7yanGuVxzlBhpB90INXVDX9+yQ23XHECAwEAAaAAMA0GnCSqGSIb3DQEBBQUAA4IBAQAwbFXORWmD9ovp4qsxozzUZAKxUTluiTIsO+bK2pXVnHAhxVkzcVi8nFqzkeAuKRTQ9UZPMjnnjHWOKIghIpiAabSiC0E/0SPR9s3QzJWhVnOfOpoKYoRnDUh+/SH/Otg4Wid7yKOfdPFK4J8GtnPB2i5Eih0ZOYTTIU2xSmkZ9Tn+LoB7PxOVii8Dq5Nrbbzq8x/WpJfKTackp6nWl2ILcfXM3iGBmLqXPRn5/Uvj767nrq5mHXD2IakxBAeTci16WqQEVcow3qn1JwLyGOzXuuW/UA2/HJUE4zG+8CQIb3OLn0Yq26QKt/i5CJv//uZcRZY8VRkPaH090QOr85UfP7Y3Dn-----END CERTIFICATE REQUEST-----
domains

Array of 1 or more domains to query.

string, optional
example: [www.domain1.com, domain2.info, mail.domain3.biz]

Response

201 (Created)
Content-Type: application/json
{"instructions":"https://support.ssl.com/Knowledgebase/Article/View/29/0/alternative-methods-of-domain-control-validation-dcv","md5_hash":"FAFC4EBB4DD8308F0A5E8851C3B77363","sha1_hash":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521","dcv_methods":{"exchange.ecossl.com":{"email_addresses":["customerservice@networksolutions.com","cecossl@ecossl.com","webmaster@ecossl.com","postmaster@ecossl.com","hostmaster@ecossl.com","administrator@ecossl.com","admin@ecossl.com","webmaster@exchange.ecossl.com","postmaster@exchange.ecossl.com","hostmaster@exchange.ecossl.com","administrator@exchange.ecossl.com","admin@exchange.ecossl.com"],"http_csr_hash":{"http":"http://exchange.ecossl.COM/FAFC4EBB4DD8308F0A5E8851C3B77363.txt","allow_https":"true","contents":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521\ncomodoca.com"},"cname_csr_hash":{"cname":"FAFC4EBB4DD8308F0A5E8851C3B77363.exchange.ecossl.COM. CNAME E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com.","name":"FAFC4EBB4DD8308F0A5E8851C3B77363.exchange.ecossl.COM","value":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com."}},"facebook.com":{"email_addresses":["domain@fb.com","webmaster@facebook.com","postmaster@facebook.com","hostmaster@facebook.com","administrator@facebook.com","admin@facebook.com"],"http_csr_hash":{"http":"http://facebook.com/FAFC4EBB4DD8308F0A5E8851C3B77363.txt","allow_https":"true","contents":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521\ncomodoca.com"},"cname_csr_hash":{"cname":"FAFC4EBB4DD8308F0A5E8851C3B77363.facebook.com. CNAME E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com.","name":"FAFC4EBB4DD8308F0A5E8851C3B77363.facebook.com","value":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com."}},"google.com":{"email_addresses":["dns-admin@google.com","webmaster@google.com","postmaster@google.com","hostmaster@google.com","administrator@google.com","admin@google.com"],"http_csr_hash":{"http":"http://google.com/FAFC4EBB4DD8308F0A5E8851C3B77363.txt","allow_https":"true","contents":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521\ncomodoca.com"},"cname_csr_hash":{"cname":"FAFC4EBB4DD8308F0A5E8851C3B77363.google.com. CNAME E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com.","name":"FAFC4EBB4DD8308F0A5E8851C3B77363.google.com","value":"E1ADE457485814DAE2847D6DF69AD0C9EFE41521.comodoca.com."}}}}

SSL Certificate API Parameters

A list of pre-filled parameters needed to make a successful api call

Retrieve acceptable domain validation methods for Certificate

GET

/certificate/{ref}/api_parameters/{action}{?account_key,secret_key}

Parameters
Name Description Details
account_key

The SWS account key of the reseller account.

string, required
example: xxxxxxxxx
secret_key

The SWS secret key of the reseller account.

string, required
example: yyyyyyyyy
ref

String ref is the certificate reference number (or voucher code) of the SSL.com certificate order. Has example value.

string, required
example: co-xxxx
action

This is the valid action that api intends to call. The returned parameters can then be used in that api action call. Valid actions are: update_dcv, update, create_w_csr, create, show, index, dcv_emails, dcv_methods_wo_csr and dcv_methods_w_csr. Please note that some actions cannot be executed such as update_dcv if the csr has not already been submitted.

string, required
example: create

Response

200 (OK)
Content-Type: application/json
{"instructions":"https://support.ssl.com/Knowledgebase/Article/View/29/0/alternative-methods-of-domain-control-validation-dcv","md5_hash":"FCC429296A9B86FBF296C853138D707B","sha1_hash":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8","dcv_methods":{"www.test4.com":{"email_addresses":["domain.privacy.services.ltd@gmail.com","webmaster@test4.com","postmaster@test4.com","hostmaster@test4.com","administrator@test4.com","admin@test4.com","webmaster@www.test4.com","postmaster@www.test4.com","hostmaster@www.test4.com","administrator@www.test4.com","admin@www.test4.com"],"http_csr_hash":{"http":"http://www.test4.com/FCC429296A9B86FBF296C853138D707B.txt","allow_https":"true","contents":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8\ncomodoca.com"},"cname_csr_hash":{"cname":"FCC429296A9B86FBF296C853138D707B.www.test4.com. CNAME B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com.","name":"FCC429296A9B86FBF296C853138D707B.www.test4.com","value":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com."}},"www.abc.de":{"email_addresses":["noc@work.de","webmaster@abc.de","postmaster@abc.de","hostmaster@abc.de","administrator@abc.de","admin@abc.de","webmaster@www.abc.de","postmaster@www.abc.de","hostmaster@www.abc.de","administrator@www.abc.de","admin@www.abc.de"],"http_csr_hash":{"http":"http://www.abc.de/FCC429296A9B86FBF296C853138D707B.txt","allow_https":"true","contents":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8\ncomodoca.com"},"cname_csr_hash":{"cname":"FCC429296A9B86FBF296C853138D707B.www.abc.de. CNAME B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com.","name":"FCC429296A9B86FBF296C853138D707B.www.abc.de","value":"B775FC14E5C7CD1EF51749CCE6FFEB7B466D20F8.comodoca.com."}}}}

Users

Users related resources of the SSL.com API

Users Collection

Create a User account

POST

/users

Create an ssl.com user login and account. Upon successful api call, a user account will be created and the resulting api credentials will be returned. Use these api credentials to access other resources in the SSL.com api.

The User request has the following parameters:

Parameters
Name Description Details
login

The desired login name of the new SSL.com user account.

string, required
example: ssl_demo
email

The email address associated with the new SSL.com user account.

string, required
example: api@ssl.com
password

The desired password used to login into SSL.com with the new user account.

string, required
example: !Ss1_c3Rt$

Response

201 (Created)
Content-Type: application/json
{"account_key":"37d66172787f","secret_key":"JRDNcueCDkuw6g==","status":"enabled","user_url":"https://www.ssl.com/users/1296066"}

User

A single User object with all its details. Also call this method to get the latest api credentials that are required for other resources within the SSL.com api.

Retrieve a User

GET

/user/{login}/{?password}

Parameters
Name Description Details
login

The login name of the existing SSL.com user account.

string, required
example: ssl_demo
password

The corresponding password used to log into the SSL.com account belonging to 'login'.

string, required
example: !Ss1_c3Rt$

Response

200 (OK)
Content-Type: application/json
X-My-Header: The Value
{"login":"ssl_demo","email":"!Ss1_c3Rt$","account_number":"ad6-1aciqq7","account_key":"d559d1dbeffa","secret_key":"/J8VgsejyPXFlQ==","status":"enabled","user_url":"https://www.ssl.com/users/1296067","available_funds":"$0.00"}