Knowledge Base

Check for answers to your questions by searching by keywords, or check categories below.

1 Choosing a product

This is a series of articles dedicated to demonstrating how to get acquainted with Openprovider SSL API methods.

To get more information about the Openprovider API in general, please use our documentation portal as your reference.

Before ordering an SSL Certificate, you'll need to decide on the product appropriate for your purposes.

Different products have a wide variety of options and are suitable for almost all use cases.
You can check this article to understand the differences between certificates.
Method allows you to retrieve a list of the products offered in the SSL Panel with their parameters and prices.

Entering Geo Fence icon Use endpoint path below. Base URL is determined by both the target environment and API version.
GET {base_url}/ssl/products

REQUEST VALUES

 Name

 Type

 Values

 Description

 limit  numeric  Default: 0, Max: 1000
The maximum number of records to be returned.
 offset  numeric  Default: 0 Indicate the starting position of the response list. Indexing starts at 0, meaning that in order to start with the 10th certificate, this value would be 9.
 with_price  boolean

true or false

Include product price (for creation, payments for extra domains, etc.) in the response.
Note that the warranty price will be displayed in any case.

 with_supported_software  boolean true or false

Include a list of available platforms.

 with_description  boolean true or false

Include the description for each product, if it exists.


REQUEST EXAMPLE

curl -X GET \
https://api.cte.openprovider.eu/v1beta/ssl/products \
-H 'Authorization: Bearer a****************************z' \
-H 'Content-Type: application/json' \
-d '{
"limit": "2",
"offset": "1",
"with_price": "true",
"with_supported_software": "true",
"with_description": "true"
}'

RESPONSE EXAMPLE

{
"code": 0,
"data": {
"results": [
{
"id": 24,
"name": "EV SSL",
"brand_name": "Comodo",
"category": "extended_validation",
"is_mobile_supported": true,
"is_idn_supported": false,
"is_sgc_supported": false,
"is_wildcard_supported": false,
"is_extended_validation_supported": true,
"delivery_time": "within 1 day",
"free_refund_period": "30d",
"free_reissue_period": "lifetime",
"max_period": 2,
"number_of_domains": 1,
"encryption": "40/256 bits",
"root": "Chained root",
"validation_method": "extended",
"warranty": {
"product": {
"price": 250000,
"currency": "USD"
},
"reseller": {
"price": 16286475,
"currency": "RUB"
}
},
"bypass_san": false,
"included_domains_count": 1,
"max_domains": 1,
"order_module": "comodo"
},
{
"id": 33,
"name": "EVSSL multi-domain",
"brand_name": "Comodo",
"category": "multi_domain",
"sub_category": "extended_validation",
"is_mobile_supported": true,
"is_idn_supported": false,
"is_sgc_supported": false,
"is_wildcard_supported": false,
"is_extended_validation_supported": true,
"delivery_time": "within 1 day",
"free_refund_period": "30d",
"free_reissue_period": "lifetime",
"max_period": 2,
"number_of_domains": 3,
"encryption": "40/256 bits",
"root": "Chained root",
"validation_method": "extended",
"warranty": {
"product": {
"price": 250000,
"currency": "USD"
},
"reseller": {
"price": 16286475,
"currency": "RUB"
}
},
"bypass_san": false,
"included_domains_count": 3,
"max_domains": 210,
"order_module": "comodo"
}
],
"total": 30
}
}

RESPONSE VALUES

Name

Values

Description

code

result code number

API Result with code returned.
0 = Success with no errors.
1. data set of values Lists Products Response Data.
1.1 results

array 

Array of SSL Product parameters.
1.1.1 brand_name string Product manufacturer brand.
1.1.2 bypass_san  boolean Bypass SAN (Subject Alternative Name) (deprecated).
1.1.3 category string Product category: DV, OV, EV (e.g. domain_validation etc.).
1.1.4 delivery_time string Average period of time between order creation and completion.
1.1.5 description string  Marketing description (if it exist).
1.1.6 encryption string Indicates the encryption level of the root certificate (40/256 bits or 128/256 bits).
1.1.7 free_refund_period string  The period during which cancellation of the product can be refunded
1.1.8 free_reissue_period string The period during which reissue is not charged
1.1.9 id integer Openprovider Product ID.
1.1.10 included_domains_count integer

The included domains count.
'-1' in a case of Wildcard product or 1,2,3 in a case of Single/Multidomain product.

1.1.11 is_extended_validation_supported boolean If product supports Extended Validation.
Indicates if identifying the legal entity required.
1.1.12 is_idn_supported boolean If IDN domain names are supported.
1.1.13 is_mobile_supported boolean If mobile devices are supported (deprecated).
1.1.14 is_sgc_supported boolean If Server Gated Cryptography supported (deprecated).
1.1.15 is_wildcard_supported boolean If product supports wildcard certificates.
1.2 level prices array List of level prices.
1.2.1 level integer Price level.
1.2.2 name string  Product name.
1.3 prices array  An array of SSL product prices.
1.3.1 extra domain price set of values
The extra (additional) domain price.
1.3.1.1 product set of values SSL Product parameters and values.
1.3.1.1.1 currency string Currency value.
1.3.1.1.2 price number Price amount.
1.3.1.2 reseller set of values Indicates values returned for the current reseller.
1.3.1.2.1 currency string Type of currency.
1.3.1.2.2 price number Price value.
1.3.2 period integer Lifetime period in years
1.3.3 price number Price value.
1.3.3.1 product set of values SSL Product parameters and values.
1.3.3.1.1 currency string Currency value.
1.3.3.1.2 price number Price amount.
1.3.3.2 reseller   Indicates values returned for current reseller.
1.3.3.2.1 currency string Currency value.
1.3.3.2.2 price number Price value.
max_domains integer Applies only to multi-domain certificates.
Indicates the maximum number of additional domains which can be added
max_period integer Maximal period of product lifetime.
name string Product name.
number_of_domains integer Indicates domain(s) quantity included in the regular price. Extends in a case of Multi-domain products but for an additional fee.
order_module   Indicates module that is related to the current product (Comodo).
1.4. prices array Array of price parameters and values.
1.4.1 extra_domain_price set of values Group of parameters indicating price for additional (extra) domains.
1.4.1.1 product set of values SSL Product parameters and values.
1.4.1.1.1 currency string Currency value.
1.4.1.1.2 price number Price value.
3.1.2 reseller set of values List of values actual for current reseller account.
3.1.2.1 currency string Currency value.
3.1.2.2 price number  Price value.
period integer Lifetime period (in years, e.g. 1 or 2).
1.4.2 price   Price value.
1.4.2.1 product set of values SSL Product parameters and values.
1.4.2.1.1 currency string Currency value.
1.4.2.1.2 price number Price value.
1.4.2.2 reseller set of values  List of values actual for the current reseller account.
1.4.2.2.1 currency string  Currency value.
1.4.2.2.2 price number Price value.
root string Default: chained root. 
sub_category string A sub-category of the product (deprecated field).
1.5. supported_software array An array of supported software: ID and title (Windows or/and Linux)
1.5.1 id string  
1.5.2 title string Windows or Linux value.
validation_method string Indicates the validation method required for certificate issuance (domain, organization or extended).
1.6 warranty   Returns an array of the warranty in USD and also converted into reseller currency (10000 USD or 50000 USD or 100000 USD or 250000 USD).
1.6.1 product set of values SSL Product parameters and values.
1.6.1.1 currency string Currency.
1.6.1.2 price number Price value.
1.6.2 reseller set of values List of values actual for a current reseller account.
1.6.2.1 currency string Currency value.
1.6.2.2 price number  Price value.
total integer Total number of certificates in the product catalog
desc string Description (if presented).
maintenance boolean Indicates if Openprovider is under maintenance mode.
2. warnings array An array of warning messages.
2.1 code integer Code value (digits).
2.2 data string Data value returned.
2.3 desc string Description value returned.

Using the first request we retrieved the RapidSSL product and it's parameters.
If we are protecting a single domain and do not want to pass organization validation then RapidSSL would be a great choice. Please note there is one more similar method allowing retrieval of exact product data using Openprovider Product ID value, you can get familiar with this method here.
Let us move forward and create CSR string that will be used for SSL Order creation.

Was this article helpful?
0 out of 0 found this helpful