GoGetSSL API Guide · GoGetSSL API Guide Version: 2.9(stable) ... 1. Requestor supplies the CSR,...

Page - 1

EnVers Group SIA Liesmas 4-24, Riga, Latvia, LV-1058

www.gogetssl.com.com [email protected]

GoGetSSL API Guide

Version: 2.9(stable)

Dear Partners/Re-sellers, this is second version of our API for re-selling SSL Certificates. We try to be flexible, that’s why if you see any missing functionality in our API, than simply contact us and we will develop custom API methods quickly. Thank you for choosing us.

Table of contents

Overview…………………………………………………………………………………………………………………….

Using the API …………………………………………………………………..…………………………………………………..

a. UI-BASED Domain Vetting Ordering Scenario…………………………………………………………..…..

b. UI-BASED Organization Vetted Product Ordering Scenario……………………………………………

c. Comodo UI-based Organization Vetter Product Ordering Scenario………………………………...

d. UI-Based Doman and Organization Vetted Product Ordering Scenario………………..…………

Web Service Information……………………………………………………………………………………………………..

API Methods………………………………………………………………………………………………………………………..

Order Methods……………………………………………………………………………………………………………………..

a. addSSLOrder……………………………………………………………………………………………………………….

b. addSSLRenewOrder ……………………………………………………………………………………………………

c. getOrderStatus…………………………………………………………………………………………………………

d. getOrderInvoice…………………………………………………………………………………………………………..

e. getUnpaidOrders…………………………………………………………………………………………………………

f. activateSSLOrder………………………………………………………………………………………………………..

g. reIssueSSLOrder…………………………………………………………………………………………………………..

h. comodoClaimFreeEV………………………………………………………………………………………………….

Account methods…………………………………………………………………………………………………………………

a. getAccountBalance……………………………………………………………………………………………………

b. getAccountDetails………………………………………………………………………………………………………

c. getTotalOrders……………………………………………………………………………………………………………

d. getAllInvoices………………………………………………………………………………………………………………

e. getUnpaidInvoices………………………………………………………………………………………………………

Product methods…………………………………………………………………………………………………………………

a. getAllProducts…………………………………………………………………………………………………………

b. getAllProductPrices……………………………………………………………………………………………………

c. getProductDetails………………………………………………………………………………………………………

d. getProductPrice…………………………………………………………………………………………………………

e. getUserAgreement……………………………………………………………………………………………………

3

3

4

4

5

6

6

7

8

8

10

12

12

13

14

14

15

16

16

16

17

17

18

18

19

19

19

20

20

21

Page - 2



Other merhods……………………………………………………………………………………………………………………

a. getDomainEmails……………………………………………………………………………………………………

b. decodeCSR………………………………………………………………………………………………………………

c. getWebServers……………………………………………………………………………………………………………

d. generateCSR………………………………………………………………………………………………………………

e. getCSR…………………………………………………………………………………………………………………………

21

21

22

22

23

Page - 3



Overview

We offer a REST Request Format API with JavaScript Object Notation (JSON) response format for our

partners to directly order and manage their certificate and website identity offerings. API clients can

perform functions such as ordering the different products, canceling and fulfilling orders, and

querying for order data, and querying for account details data. This API document contains all of the

data necessary to integrate with GoGetSSL. Our REST API follows a easy-to-guess Naming convention

which makes it a breeze to use it in your projects.

Using the API Different API commands are used for initiating or placing an order for server products and client

certificate products. Using the API offers additional workflow flexibility beyond the basic UI-based ordering flow. Utilized

in conjunction with selectively enabling or disabling different automated email communications to a

customer, a partner can perform varying levels of the ordering workflow. This allows the integration

with our API to be tailored to best suit the needs of the partner’s overall provisioning process. Ordering state changes for SSL certificates and server web identity products are asynchronous - an

API client initiates an order and then later checks the server for the completed order after the vetting

process has been completed. The general approach is to specifically request the status of a specific order. In this case (Figure 2), the

ordering flow consists of the following operations: (1) place an order, and then (2) periodically check

the status of the specific order . Once the order has been completed, the fulfillment information is

returned with the GetOrderStatus operation.

This approach is generally less efficient,

but might be more appropriate when there is

a low volume of certificates being managed.

How an order is processed by our support team is dictated by the vetting process employed for a

given product. We employ a suite of advanced techniques to vet orders to ensure the authenticity of

the requestor. This axiom applies to the API as well. While the same API commands are used to initiate

orders for all server products, specific field usages for a given command are also dictated by the

vetting requirements of the specified product. To best understand how the API is used to initiate an

order, the following subsections provide an overview of the basic process flows for Domain Vetting, Organization Vetting and Domain and Organization Vetting, and how the API is used in conjunction

with these vetting approaches.

Page - 4



UI-BASED Domain Vetting Ordering Scenario

We use GeoTrust and thawte’s patented Domain Vetting process ensures that a registered contact for

a domain approves a request for a server product for that domain. QuickSSL Premium, RapidSSL,

RapidSSL Wildcard, thawte SSL123, FreeSSL, Comodo Essential SSL, Comodo PositiveSSL, Comodo

Essential Wildcard SSL, Comodo Wildcard PositiveSSL and the GeoTrust Free Trial SSL are products

that are Domain Vetted. The Web based ordering process for requesting, approving and issuing

certificates is described below:

1. Requestor supplies the CSR, and order contact information. Requestor then chooses an Approver email, accepts the subscriber agreement and submits the order.

2. An acknowledgement email is sent to the requestor and other order contacts confirming placement of the order.

3. An email is sent to the Approver requesting that the Approver review the submitted order.

4. The Approver follows the link in the email, reviews the order information and either approves or rejects the order.

5. If the order is approved, the requestor receives the certificate via email.

UI-BASED Organization Vetted Product Ordering Scenario

With Organization Vetting only, validation of the Organizational data submitted with the order is also

performed before completing a product order. GeoTrust’s True BusinessID, Verisign’s Secure Site,

Secure Site Pro, Secure Site with EV, Secure Site Pro with EV, Certified Seal, Trust Seal and Code

Signing Certificates and thawte’s SSL WebServer, SSL Web Server with EV, SSL Web Server Wildcard,

SGC Supercert and Code Signing Certificates are Organization Vetted products where the organization

and domain authentication are done manually using Symantec’s authentication practices. Symantec

Partner Authentication orders use the process flow below as well:

Requestor supplies the CSR, organization information, and the order contact information. Requestor then accepts

the subscriber agreement and submits the order.

Page - 5



An acknowledgement email is sent to the requestor and other order contacts confirming placement of the order.

Customer sends corporate documents and other information necessary to verify the organization to the GeoTrust, thawte or Symantec authentication team. This may be an iterative process with GeoTrust, thawte or Symantec sending out requests for additional information.

Verify call is placed to the Organization Contact by Geotrust's authentication team (for Symantec and thawte branded products only).

Once all the authentication steps have been successfully completed, the certificate is issued.

Comodo UI-BASED Organization Vetted Product Ordering Scenario

With Organization Vetting only, validation of the Organizational data submitted with the order is also

performed before completing a product order Instant SSL, Instant SSL PRO, Instant SSL Premium,

PremiumSSL Wildcard, Comodo EV SSL, Comodo EV MDC, Comodo Unified Communication, Comodo

Multi Domain Certificates are Organization Vetted products where the organization and domain

authentication are done manually using Comodo’s authentication practices. Symantec Partner

Authentication orders use the process flow below as well:

Requestor supplies the CSR, organization information, and

the order contact information. Requestor then accepts the subscriber agreement and submits the order.


Customer sends corporate documents and other information necessary to verify the organization to the Comodo authentication team. This may be an iterative process with Comodo sending out requests for additional information.

Verify call is placed to the Organization Contact by Comodo's authentication team (for EV SSL and EV SSL Multi Domain branded products only).

Once all the authentication steps have been successfully completed, the certificate is issued.

Page - 6



UI-BASED Domain and Organization Vetted Product Ordering Scenario

With Domain and Organization Vetting, extensive validation of the requestor’s Organizational information is also performed before completing a product order.

Requestor supplies the CSR, organization information, and the order contact information. Requestor then chooses an Approver email, accepts the subscriber agreement and submits the order.


Customer sends corporate documents and other information necessary to verify the organization. This may be an iterative process with Symantec/Comodo sending out requests for additional information.

An email is sent to the Approver requesting that the Approver review the submitted order.

The Approver follows the link in the email, reviews the order information and either approves or rejects the order.

Upon completion of the vetting and approval process, the organization and tech contact receive the certificate via email.

Web Service Information

This section contains important information about how to establish a test account and perform

testing. If you already have a test account in place, please notify [email protected] if you have any

query.

If you do not already have a test account set up, you should register for a test account to aid your API

client development. To register as a GoGetSSL partner on our customer test system send an email to

[email protected] providing your account login which is used on live website:

https://my.gogetssl.com/

The ORDER Web Service is a set of operations for allowing a partner to place or initiate an order.

mailto:[email protected]

mailto:[email protected]


Page - 7



Test API https://sandbox.gogetssl.com/api/

Live API

https://my.gogetssl.com/api/

NOTE: fields marked with a ‘()?’ are optional for that command. All JSON API requests result in a

success value or error value. The two basic variables are: success => 1 and error => 1. All described

API methods below are implemented in example scripts using file class: GoGetSSLApi.php which can

be downloaded in API Settings section in clients Control Panel (https://my.gogetssl.com/).

If errors in a request the following information is provided in the response:

error - incremental number message - error message code description - error description


Page - 8



API Methods

Authentication ----------------------------------------------------------------------------------------------------------------------------------- “auth” URL: /auth/ Request type: POST Overview The “auth” method authenticate partner and returns unique “key” parameter, which can be used after

for querying GoGetSSL API

Request parameters

user – Username pass – API usage password

Response

If no errors in request following parameters will be returned:

key - unique session key -----------------------------------------------------------------------------------------------------------------------------------

Order methods “addSSLOrder”

URL: /orders/add_ssl_order/ Request type: POST

Overview AddSSLOrder allows a Partner to do everything a requestor would typically do using our web forms

for placing an order via one API operation call. This includes submitting the full order information,

such as Technical Contact, Administrative Contact, and CSR as well as, Approver Email Address (if

applicable). Our system validates that the Approver email address is checked against the set of

Approver email addresses that would have been presented to the requestor and can only be

successful if there is a match.

Upon successful submission of a addSSLOrder command, Our system automatically sends two email

Messages:

1. an email acknowledging successful submission of the order is sent to the Partner email address

Page - 9



2. An email requesting review and approval is sent to the specified approver for the order upon

order submission (for domain vetted products and True BusinessID with EV only).

From this point forward, the order is processed in the same manner as an order that was submitted

via the standard web user interface

Request parameters:

product_id - Required. product ID, can be taken from getAllProducts methods

period - Required . period in months

csr - Required . CSR code for SSL certificate

server_count - Required . amount of servers, for Unlimited pass “-1”

approver_email - Required . DCV approver email for the primary domain, can be taken from

the list provided by getDomainEmails* methods. This parameter must be used only if

dcv_method prameter value is 'email'.

approver_emails - A comma separated list of domain control validation e-mail addresses. One

and only one e-mail must be provided for each additional domain provided in dns_names

parameter. DCV e-mail address for the primary domain must not be included to the list. This

parameter must be used only if dcv_method prameter value is 'email'.

webserver_type - Required . webserver type, can be taken from getWebservers method

dns_names – Required for SAN/UCC/Multi-Domain SSL, for the rest of products this parameter

must not be provided. A comma separated list of additional domain names. The list must not

contain the primary domain.

admin_firstname - Required .

admin_lastname - Required.

admin_organization - required for OV SSL certificates

admin_addressline1

admin_phone - Required .

admin_title - Required .

admin_email - Required .

admin_city - required for OV SSL certificates

admin_country - required for OV SSL certificates

admin_fax - required for OV SSL certificates

admin_postalcode

admin_region

dcv_method – Required. Value of this specifies DCV method to be used. Possible values: 'email',

'http', 'https', 'dns'.

tech_firstname - Required .

tech_lastname - Required .

tech_organization - required for OV SSL certificates

tech_addressline1

Page - 10



tech_phone - Required .

tech_title - Required .

tech_email - Required .

tech_city- required for OV SSL certificates

tech_country - required for OV SSL certificates

tech_fax

tech_postalcode

tech_region

org_name - required for OV SSL certificates

org_division - required for OV SSL certificates

org_duns

org_addressline1 - required for OV SSL certificates

org_city - required for OV SSL certificates

org_country - required for OV SSL certificates

org_fax

org_phone - required for OV SSL certificates

org_postalcode - required for OV SSL certificates

org_region - required for OV SSL certificates

signature_hash – hashing algorythm (either 'SHA1' or 'SHA2')

Note: Quantity of items in the approver_emails list must be always equal to quantity of items in

the dns_names list.

Response If no errors in request following parameters will be returned:

order_id - unique order ID

invoice_id - unique invoice ID

order_amount - order amount

currency - order currency

tax - order tax if applicable

tax_rate - order tax rate if applicable

success - success code (true)

“addSSLRenewOrder” URL: /orders/add_ssl_renew_order/ Request type: POST Overview

Page - 11



AddSSLRenewOrder allows a Partner to do everything a requestor would typically do using our web

forms for placing an renew order via one API operation call. This includes submitting the full order

information, such as Technical Contact, Administrative Contact, and CSR as well as, Approver Email

Address (if applicable). Our system validates that the Approver email address is checked against the

set of Approver email addresses that would have been presented to the requestor and can only be

successful if there is a match. In case of an order renewal the system also adds 90 days on top of the

validity period, in order to ensure time for the original certificate expiration.

Upon successful submission of a addSSLRenewOrder command, Our system automatically sends two

email messages:

1. an email acknowledging successful submission of the order is sent to the Partner email address

2. An email requesting review and approval is sent to the specified approver for the order upon

order submission (for domain vetted products and True BusinessID with EV only).

From this point forward, the order is processed in the same manner as an order that was submitted

via the standard web user interface

Request parameters

The same as for the addSslOrder method.

Response The same as for the addSslOrder method

----------------------------------------------------------------------------------------------------------------------------------- “addSSLSANOrder” URL: /orders/add_ssl_san_order/ Request type: POST

Overview Order additional SAN/s method. Use that method to add more SAN names to your Multi-Domain SSL certificates, once SAN is added to the order, you will need to reissue SSL. Request parameters

order_id - ORDER ID to which we will add new SAN count - Quantity of SAN names to add

Response If no errors in request following parameters will be returned:

order_id - unique order ID invoice_id

Page - 12



----------------------------------------------------------------------------------------------------------------------------------- “getOrderStatus” URL: /orders/status/<order_id>

Overview

The getOrderStatus returns detailed information for the order matching “order_id” parameter.

“order_id” is returned during addSSLOrder command.

Request parameters

order_id

Response



partner_order_id - unique ID returned from partner (Comodo or Thawte)

status - order status (active, pending, canceled, payment needed, processing, incomplete)

status_description

product_id - product ID

domain - order submitted domains or FQDN from CSR

approver_method

domains

total_domains - total domains count

validity_period - order validity period in months

valid_from

valid_till

csr_code - CSR code of certificate returned if status “active”

ca_code - CA code of certificate id status “active”

crt_code - Certificate code is status “active”

server_count

renew

webserver_type

upgrade

approver_emails

dcv_method

admin_addressline1

admin_addressline2

org_addressline3

org_city

org_country

Page - 13



org_fax

org_phone

org_postalcode

org_region

tech_organization

tech_addressline1

tech_addressline2

tech_addressline3

tech_city

tech_country

tech_fax

tech_phone

tech_postalcode

tech_region

tech_email

tech_firstname

tech_lastname

tech_title

ssl_price

ssl_period

partner_sslid

free_ev_upgrade

goget_website

codesigning_inviteurl

validation_description


----------------------------------------------------------------------------------------------------------------------------------- “getOrderInvoice” URL: /orders/invoice/<order_id> Request type: GET

Overview

The getOrderInvoice returns detailed information for the invoice matching “invoice_id” parameter.

“invoice_id” is returned during addSSLOrder command.

Request parameters

order_id

Page - 14



Response



number - invoice unique number

date - invoice creation date

subtotal - invoice subtotal amount

tax - invoice tax amount

tax_rate - invoice tax rate in %

total - invoice total amount

status - invoice status (paid, unpaid)

currency - invoice currency

payment_method - invoice payment method (paypal, interkassa, bank_transfer, balance)


-----------------------------------------------------------------------------------------------------------------------------------

“getUnpaidOrders” URL: /orders/list/unpaid/ Request type: GET Overview

The “getUnpaidOrders” method returns list of all unpaid orders.

Request parameters

None.

Response

orders - array of unpaid orders

o id - order ID

o total_price - order total price

o currency - order currency

o date - order date

----------------------------------------------------------------------------------------------------------------------------------- “reIssueSSLOrder” URL: /orders/ssl/reissue/<order_id> Request type: POST

Overview

Page - 15



The reIssueSSLOrder method process with SSL certificate reissue procedure if you have lost your

private key, or you want to add more SAN names for Multi Domain or UCC orders.

Request parameters

order_id - your order ID returned in addSSLOrder method

csr - CSR code for SSL certificate

approver_email - approver email, can be taken from getDomainEmails* methods

approver_emails - A comma separated list of domain control validation e-mail addresses. One

and only one e-mail must be provided for each additional domain. DCV e-mail address for the

primary domain must not be included to the list.

webserver_type - webserver type, can be taken from getWebservers method.

dns_names – Required for SAN/UCC/Multi-Domain SSL. A comma separated list of additional

domain names. The list must not contain the primary domain.

dcv_method – Domain Control Validation method (email, http, dns).

signature_hash – hashing algorythm (either 'SHA1' or 'SHA2').

Response



order_status - order status (reissue)

validation – Contains validation invormation in case of http and dnc DCV methods


----------------------------------------------------------------------------------------------------------------------------------- “comodoClaimFreeEV” URL: /orders/ssl/comodo_claim_free_ev/<order_id> Request type: POST Overview

The comodoClaimFreeEV method process with free EV upgrade for Comodo DV orders with default

term of 1 year. Email for validation and further information of all required documents from

company/organization will be sent to “admin_email” address, specified in order: <order_id>.

Request parameters

order_id - your order ID returned in addSSLOrder method

org_name - Organization name

org_division - Organization division

org_duns

org_addressline1 - Organization address 1

org_city - Organization city

Page - 16



org_country - Organization country ISO format

org_fax

org_phone - Organization phone

org_postalcode - Organization postal code

org_region - Organization region

Response




“resendValidationEmail” URL: /orders/ssl/resend_validation_email/<order_id> Request type: GET

Overview

The resendValidationEmail method re-sends validation e-mail for the order matching “order_id”

parameter.

Request parameters

order_id - Id of the order

Response

messge - error message or code

success - result code

----------------------------------------------------------------------------------------------------------------------------------- “cancelSSLOrder” URL: /orders/cancel_ssl_order/ Request type: POST

Overview Use that option to request cancellation/refund of any order. Please note, we respond during 24-48 hours to all requests. Request parameters

order_id - ID of the order to be cancelled reason – Cancellation reason

Response If no errors in request following parameters will be returned: - order_id - unique order ID

Page - 17



-----------------------------------------------------------------------------------------------------------------------------------

Page - 18



Account methods

----------------------------------------------------------------------------------------------------------------------------------- “getAccountBalance” URL: /account/balance/ Request type: GET Overview

The getAccountBalance method returns available credits for partner account.

Request parameters

None

Response

balance - account available credit

currency - currency of available credit

success - success value (true)

----------------------------------------------------------------------------------------------------------------------------------- “getAccountDetails” URL: /account/ Request type: GET Overview

The getAccountDetails returns partner account details information

Request parameters

None

Response

first_name

last_name

company_name - company name

company_vat - company VAT/SN/DUNS

company_phone

phone

fax

address

city

state

Page - 19



postal_code

country

email - partner email address

reseller_plan - current partner plan type

currency - account default currency


----------------------------------------------------------------------------------------------------------------------------------- “getTotalOrders” URL: /account/total_orders/ Request type: GET

Overview

The getTotalOrders method returns total order count.

Request parameters

None

Response

total_orders - total active orders count


----------------------------------------------------------------------------------------------------------------------------------- “getAllInvoices” URL: /account/invoices/ Request type: GET

Overview

The getAllInvoices method returns list of all partner invoices.

Request parameters

None

Response

invoices - array of invoices

o order_id - invoice order ID

o number - invoice serial number

o date - invoice creation date

o subtotal - subtotal amount

o tax - invoice tax amount

o total - invoice total amount

o status - invoice status (paid, unpaid)

Page - 20



o tax_rate - invoice tax rate in %

o currency - invoice currency

o payment_method - invoice payment method (paypal, interkassa, balance, bank_transfer)


---------------------------------------------------------------------------------------------------------------------------------- “getTotalTransactions” URL: /account/total_transactions/ Request type: GET

Overview

The getTotalTransactions method returns list of partner unpaid invoices.

Request parameters

None

Response

total_transactions – count of payments performed by the customer


“getUnpaidInvoices” URL: /account/invoices/unpaid/ Request type: GET

Overview

The getUnpaidInvoices method returns list of partner unpaid invoices.

Request parameters

None

Response

invoices - array of invoices

o order_id - invoice order ID

o number - invoice serial number

o date - invoice creation date

o tax - invoice tax amount

o tax_rate - invoice tax rate in %

o subtotal - subtotal amount

o total - invoice total amount

o currency - invoice currency

o payment_method - invoice payment method (paypal, interkassa, balance, bank_transfer)


Page - 21



Page - 22



Products methods

---------------------------------------------------------------------------------------------------------------------------------- “getAllProducts” URL: /products/ Request type: GET Overview

The getAllProducts method returns a detailed list of all available SSL certificate products.

Request parameters

None

Response

products - array of available products

o id - unique ID of product to be used with “addSSLOrder” method

o name - product name

o organization – is organization validation reqiured (yes, no)

o wildcard - is wildcard product (yes, no)

o unlimited_servers - is product for unlimited servers (yes,no)

o is_multidomain – is product multidomain (yes, no)

o multidomains_included – included SAN

o multidomains_maximum – max allowed SAN quantity


---------------------------------------------------------------------------------------------------------------------------------- “getAllProductPrices” URL: /products/all_prices/ Request type: GET

Overview

The getAllProductPrices returns a detailed list of available product prices.

Request parameters

None

Response

product_prices - array of product prices

o id - product ID

o period - product validity period in months (12,24,36,48,60)

o price - partner price in USD


Page - 23



---------------------------------------------------------------------------------------------------------------------------------- “getProductDetails” URL: /products/details/<product_id> Request type: GET Overview

The getProductDetails return single product details and price in USD

Request parameters

product_id - unique product ID

Response


product_name - product name

product_description - product description

product_agreement - product User Agreement

product_organization – is organization validation required

product_wildcard – are wildcard domains supported

product_unlimited_servers

product_is_multidomain – are multiple domains supported

product_multidomains_included – count of SANs included

product_multidomains_maximum – max. allowed SAN count

product_prices - array of product prices


o price - product partner price in USD


---------------------------------------------------------------------------------------------------------------------------------- “getProductPrice” URL: /products/price/<product_id> Request type: GET Overview

The getProductPrice returns product prices in USD for specified “product_id” parameter.

Request type GET

Page - 24




Response

product_price - array of product prices and period


o price - product partner price


---------------------------------------------------------------------------------------------------------------------------------- “getUserAgreement” URL: /products/agreement/<product_id> Request type: GET Overview

The getUserAgreement returns User Agreement for specified “product_id” parameter.

Request parameters


Response


product_agreement - product User Agreement


Others methods

----------------------------------------------------------------------------------------------------------------------------------- “getDomainEmails” URL: /tools/domain/emails/ Request type: POST

Overview

The getDomainEmails method returns array of valid approver email addresses for specified “domain”

parameter from Comodo API .

Request parameters

domain - valid FQDN

Page - 25



Response

If no errors:

ComodoApprovalEmails - array of valid email addresses from Comodo API -----------------------------------------------------------------------------------------------------------------------------------

“getDomainEmailsForGeotrust” URL: /tools/domain/emails/geotrust/ Request type: POST

Overview

The getDomainEmails method returns array of valid approver email addresses for specified “domain”

parameter from Geotrust API .

Request parameters

domain - valid FQDN

Response

If no errors:

GeotrustApprovalEmails - array of valid email addresses from Comodo API

----------------------------------------------------------------------------------------------------------------------------------- “decodeCSR” URL: /tools/csr/decode/ Request type: POST Overview

The decodeCSR method validates submitted CSR code. Returns parsed data in array.

Request parameters

csr - CSR code, length till 4000 simbols

Response

If no errors:

csrResult - array of decoded CSR data o CN - FQDN csr is generated for

o C - country ISO format

o OU - department

o O - organization

o L - state

o S - city

Page - 26



o Email - email address

o dnsName(s) – additional dns names

o Key Size – encryption key length

o md5 – md5 hash

o sha1 – sha1 hash


----------------------------------------------------------------------------------------------------------------------------------- “getWebservers”

URL: /tools/webservers/<supplier_id> Request type: GET

Overview The getWebservers method returns list of available web server types to be used with other API methods like “addSSLOrder”, “reIssueOrder”, etc. Request parameters

supplier_id - integer value; for Comodo: 1, for Geotrust/Symantec/Thawte: 2

Response

webservers - array of available webservers o id - ID of webserver o software - Webserver or software name

----------------------------------------------------------------------------------------------------------------------------------- “generateCSR” URL: /tools/csr/generate/ Request type: POST

Overview The generateCSR method generates valid CSR code from the submitted values (2048bits). Returns CSR code, CSR private key and CSR unique ID in array. All your generated CSR codes and CSR private keys are saved in our system, you can request it (method “getCSR”) or reuse it for SSL renew anytime. Request parameters

csr_commonname - FQDN csr is generated for, can also be IP or local-domain

csr_organization - organization name

csr_department - organization department

csr_city - city

csr_state - state

Page - 27



csr_country - country in ISO format

csr_email - email address

Response If no errors:

csr_code - CSR code, needed for SSL generation

csr_key - CSR private key, needed for SSL installation

csr_commonname - FQDN csr is generated for

csr_email

csr_organization

csr_date – CSR creation date


----------------------------------------------------------------------------------------------------------------------------------- “getCSR” URL: /tools/csr/get/ Request type: POST

Overview The getCSR method retrieves available CSR codes and CSR private keys for provided Common Name or CSR ID. Returns CSR code and CSR private key in array. Request parameters

csr_commonname - FQDN csr is generated for, can also be IP or local-domain

csr_id - unique ID returned by “generateCSR” method

Response If no errors:

csr_code - CSR code, needed for SSL generation

csr_key - CSR private key, needed for SSL installation

csr_commonname - FQDN CSR was generated for

csr_email - email address in CSR

csr_organization - organization in CSR

csr_date - date of CSR generation


-----------------------------------------------------------------------------------------------------------------------------------

Page - 28



“changeValidationEmail” URL: /orders/ssl/change_validation_email/<order_id> Request type: POST Overview This method can be used for one of the following purposes:

In case if email DCV method is already used this method can change the current DCV email address.

Another usage option is changing of the current DCV method.

Request parameters

auth_key - authentication key returned by “auth” method order_id - unique order ID approver_email – in case if email DCV method is supposed to be used, provide an approver

email address in this field. In case if email DCV method is already used, you can change current approver email address by providing another address in this field. In case of non-email DCV method please specified a desired method in this field using one of the following values: 'http', 'https', 'dns'.

Response If no errors in request following parameters will be returned for each of the DCV methods respectively: E-mail:

dcv_method – 'email' approver_email – Approver email address

HTTP: [validation] => Array ( [http] => Array ( [link] => http://example.com/851BF1CD669B199EB7C45666FF9784CA.txt [filename] => 851BF1CD669B199EB7C45666FF9784CA.txt [content] => C64D68CACBDFEBCB924B00D008820C0CA800627Acomodoca.com ) HTTPS: [validation] => Array ( [https] => Array ( [link] => https://example.com/851BF1CD669B199EB7C45666FF9784CA.txt [filename] => 851BF1CD669B199EB7C45666FF9784CA.txt [content] => C64D68CACBDFEBCB924B00D008820C0CA800627Acomodoca.com ) DNS:

Page - 29



[validation] => Array ( [dns] => Array ( [record] => 851BF1CD669B199EB7C45666FF9784CA.example.com. CNAME C64D68CACBDFEBCB924B00D008820C0CA800627A.comodoca.com. ) )

“getDomainAlternative”

URL: /tools/domain/alternative/ Request type: POST Overview This API method provides validation information for alternative DCV methods. Request parameters

csr – CSR code for which the validation invormation must be provided. Response In case of successful execution the following information must be returned: [validation] => Array ( [http] => Array ( [link] => http://example.com/851BF1CD669B199EB7C45666FF9784CA.txt [filename] => 851BF1CD669B199EB7C45666FF9784CA.txt [content] => C64D68CACBDFEBCB924B00D008820C0CA800627Acomodoca.com ) [https] => Array ( [link] => https://example.com/851BF1CD669B199EB7C45666FF9784CA.txt [filename] => 851BF1CD669B199EB7C45666FF9784CA.txt [content] => C64D68CACBDFEBCB924B00D008820C0CA800627Acomodoca.com ) [dns] => Array ( [record] => 851BF1CD669B199EB7C45666FF9784CA.example.com. CNAME C64D68CACBDFEBCB924B00D008820C0CA800627A.comodoca.com. ) )

GoGetSSL API Guide · GoGetSSL API Guide Version: 2.9(stable) ... 1. Requestor supplies the CSR,...

Documents

Transcript of GoGetSSL API Guide · GoGetSSL API Guide Version: 2.9(stable) ... 1. Requestor supplies the CSR,...