API Module SSL searchProductSslCertRequest
From Openprovider API documentation
(Difference between revisions)
m |
|||
| (4 intermediate revisions not shown) | |||
| Line 13: | Line 13: | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *limit | + | *limit ''default value: 100'' |
| - | *offset | + | *offset ''default value: 0'' |
| - | *withPrice | + | *withPrice ''default value: 0'' |
| - | *withSupportedSoftware | + | *withSupportedSoftware ''default value: 0'' |
| - | *withDescription | + | *withDescription ''default value: 0'' |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
|Result set of SSL certificate product details: | |Result set of SSL certificate product details: | ||
| - | id | + | *id |
| - | name | + | *name |
| - | brandName | + | *brandName |
| - | category | + | *category (redundant field) |
| - | isMobileSupported | + | *subcategory (redundant field) |
| - | isIdnSupported | + | *isMobileSupported |
| - | isSgcSupported | + | *isIdnSupported |
| - | isWildcardSupported | + | *isSgcSupported |
| - | isExtendedValidationSupported | + | *isWildcardSupported |
| - | deliveryTime | + | *isExtendedValidationSupported |
| - | freeRefundPeriod | + | *deliveryTime |
| - | freeReissuePeriod | + | *freeRefundPeriod |
| - | maxPeriod | + | *freeReissuePeriod |
| - | numberOfDomains | + | *maxPeriod |
| - | encryption | + | *numberOfDomains |
| - | root | + | *encryption (indicates the encryption level of the root) |
| - | warranty | + | *root (redundant field, all certificates now have chained roots) |
| - | prices (if withPrice was set to 1) | + | *validationMethod (possible values: domain, organization, extended) |
| - | supportedSoftware (if withSupportedSoftware was set to 1) | + | *warranty (returns an array of the warranty in USD and currency of the user) |
| - | description (if withDescription was set to 1) | + | *bypassSan |
| + | *includedDomainsCount (Only relevant for multi-domain certificates. Indicates how many SAN are included in the base product.) | ||
| + | *maxDomains (Only relevant for multi-domain certificates. Indicates the maximum additional domains that can be included in the product.) | ||
| + | *_orderModule (redundant field) | ||
| + | *prices (if withPrice was set to 1) | ||
| + | *supportedSoftware (if withSupportedSoftware was set to 1, possible values: windows, linux) | ||
| + | *description (if withDescription was set to 1, a small sales pitch for the certificate) | ||
|} | |} | ||
| Line 54: | Line 60: | ||
===Raw XML=== | ===Raw XML=== | ||
| + | ''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.'' | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<openXML> | <openXML> | ||
| Line 78: | Line 85: | ||
<name>Instant SGC SSL</name> | <name>Instant SGC SSL</name> | ||
<brandName>Comodo</brandName> | <brandName>Comodo</brandName> | ||
| - | <category> | + | <category>organization_validation</category> |
<isMobileSupported>0</isMobileSupported> | <isMobileSupported>0</isMobileSupported> | ||
<isIdnSupported>0</isIdnSupported> | <isIdnSupported>0</isIdnSupported> | ||
| Line 175: | Line 182: | ||
<name>SGC SuperCert</name> | <name>SGC SuperCert</name> | ||
<brandName>thawte</brandName> | <brandName>thawte</brandName> | ||
| - | <category> | + | <category>organization_validation</category> |
<isMobileSupported>1</isMobileSupported> | <isMobileSupported>1</isMobileSupported> | ||
<isIdnSupported>1</isIdnSupported> | <isIdnSupported>1</isIdnSupported> | ||
| Line 272: | Line 279: | ||
<name>Secure Site</name> | <name>Secure Site</name> | ||
<brandName>VeriSign</brandName> | <brandName>VeriSign</brandName> | ||
| - | <category> | + | <category>organization_validation</category> |
<isMobileSupported>1</isMobileSupported> | <isMobileSupported>1</isMobileSupported> | ||
<isIdnSupported>1</isIdnSupported> | <isIdnSupported>1</isIdnSupported> | ||
| Line 369: | Line 376: | ||
<name>Secure Site Pro</name> | <name>Secure Site Pro</name> | ||
<brandName>VeriSign</brandName> | <brandName>VeriSign</brandName> | ||
| - | <category> | + | <category>organization_validation</category> |
<isMobileSupported>1</isMobileSupported> | <isMobileSupported>1</isMobileSupported> | ||
<isIdnSupported>1</isIdnSupported> | <isIdnSupported>1</isIdnSupported> | ||
Current revision as of 09:05, 2 May 2016
Contents |
Module SSL certificates > Search Product
| Module | SSL certificates |
| Command name | searchProductSslCertRequest |
| Use | Returns a list of SSL certificate products matching search criteria |
| Input |
|
| Output | Result set of SSL certificate product details:
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchProductSslCertRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'orderBy' => 'brandName',
'withPrice' => true
));
Raw XML
Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<searchProductSslCertRequest>
<orderBy>brandName</orderBy>
<withPrice>1</withPrice>
</searchProductSslCertRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc />
<data>
<results>
<array>
<item>
<id>25</id>
<name>Instant SGC SSL</name>
<brandName>Comodo</brandName>
<category>organization_validation</category>
<isMobileSupported>0</isMobileSupported>
<isIdnSupported>0</isIdnSupported>
<isSgcSupported>1</isSgcSupported>
<isWildcardSupported>0</isWildcardSupported>
<isExtendedValidationSupported>0</isExtendedValidationSupported>
<deliveryTime>2d</deliveryTime>
<freeRefundPeriod>30d</freeRefundPeriod>
<freeReissuePeriod>lifetime</freeReissuePeriod>
<maxPeriod>5</maxPeriod>
<numberOfDomains>1</numberOfDomains>
<encryption>40/256 bits</encryption>
<root>Chained root</root>
<warranty>
<product>
<price>250000.00</price>
<currency>USD</currency>
</product>
<reseller>
<price>193019.77</price>
<currency>EUR</currency>
</reseller>
</warranty>
<prices>
<array>
<item>
<period>1</period>
<price>
<product>
<price>249.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>249.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>2</period>
<price>
<product>
<price>429.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>429.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>3</period>
<price>
<product>
<price>599.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>599.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>4</period>
<price>
<product>
<price>749.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>749.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>5</period>
<price>
<product>
<price>849.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>849.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
</array>
</prices>
</item>
<item>
<id>18</id>
<name>SGC SuperCert</name>
<brandName>thawte</brandName>
<category>organization_validation</category>
<isMobileSupported>1</isMobileSupported>
<isIdnSupported>1</isIdnSupported>
<isSgcSupported>1</isSgcSupported>
<isWildcardSupported>0</isWildcardSupported>
<isExtendedValidationSupported>0</isExtendedValidationSupported>
<deliveryTime>48h</deliveryTime>
<freeRefundPeriod>30d</freeRefundPeriod>
<freeReissuePeriod>lifetime</freeReissuePeriod>
<maxPeriod>5</maxPeriod>
<numberOfDomains>1</numberOfDomains>
<encryption>40/256 bits</encryption>
<root>Primary certification aut</root>
<warranty>
<product>
<price>0.00</price>
<currency>USD</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</warranty>
<prices>
<array>
<item>
<period>1</period>
<price>
<product>
<price>279.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>279.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>2</period>
<price>
<product>
<price>479.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>479.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>3</period>
<price>
<product>
<price>679.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>679.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>4</period>
<price>
<product>
<price>869.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>869.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>5</period>
<price>
<product>
<price>999.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>999.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
</array>
</prices>
</item>
<item>
<id>1</id>
<name>Secure Site</name>
<brandName>VeriSign</brandName>
<category>organization_validation</category>
<isMobileSupported>1</isMobileSupported>
<isIdnSupported>1</isIdnSupported>
<isSgcSupported>0</isSgcSupported>
<isWildcardSupported>0</isWildcardSupported>
<isExtendedValidationSupported>0</isExtendedValidationSupported>
<deliveryTime>2d</deliveryTime>
<freeRefundPeriod>30d</freeRefundPeriod>
<freeReissuePeriod>lifetime</freeReissuePeriod>
<maxPeriod>5</maxPeriod>
<numberOfDomains>1</numberOfDomains>
<encryption>40/256 bits</encryption>
<root>Class 3 Public Primary CA</root>
<warranty>
<product>
<price>100000.00</price>
<currency>USD</currency>
</product>
<reseller>
<price>77207.91</price>
<currency>EUR</currency>
</reseller>
</warranty>
<prices>
<array>
<item>
<period>1</period>
<price>
<product>
<price>275.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>275.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>2</period>
<price>
<product>
<price>499.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>499.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>3</period>
<price>
<product>
<price>699.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>699.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>4</period>
<price>
<product>
<price>879.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>879.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>5</period>
<price>
<product>
<price>1049.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>1049.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
</array>
</prices>
</item>
<item>
<id>2</id>
<name>Secure Site Pro</name>
<brandName>VeriSign</brandName>
<category>organization_validation</category>
<isMobileSupported>1</isMobileSupported>
<isIdnSupported>1</isIdnSupported>
<isSgcSupported>1</isSgcSupported>
<isWildcardSupported>0</isWildcardSupported>
<isExtendedValidationSupported>0</isExtendedValidationSupported>
<deliveryTime>2d</deliveryTime>
<freeRefundPeriod>30d</freeRefundPeriod>
<freeReissuePeriod>lifetime</freeReissuePeriod>
<maxPeriod>5</maxPeriod>
<numberOfDomains>1</numberOfDomains>
<encryption>128/256 bits</encryption>
<root>Class 3 Public Primary CA</root>
<warranty>
<product>
<price>100000.00</price>
<currency>USD</currency>
</product>
<reseller>
<price>77207.91</price>
<currency>EUR</currency>
</reseller>
</warranty>
<prices>
<array>
<item>
<period>1</period>
<price>
<product>
<price>599.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>599.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>2</period>
<price>
<product>
<price>1049.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>1049.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>3</period>
<price>
<product>
<price>1499.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>1499.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>4</period>
<price>
<product>
<price>1899.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>1899.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
<item>
<period>5</period>
<price>
<product>
<price>2199.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>2199.00</price>
<currency>EUR</currency>
</reseller>
</price>
</item>
</array>
</prices>
</item>
</array>
</results>
<total>4</total>
</data>
</reply>
</openXML>