This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Go to the new documentation

API Module SSL createSslCertRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
 
(13 intermediate revisions not shown)
Line 17: Line 17:
*'''csr'''
*'''csr'''
*'''softwareId''' (''linux'' or ''windows'')
*'''softwareId''' (''linux'' or ''windows'')
-
*hostNames
+
*[[API Format hostNames|hostNames]]
*'''organizationHandle'''
*'''organizationHandle'''
-
*'''administrativeHandle'''
+
*technicalHandle
-
*'''technicalHandle'''
+
-
*'''billingHandle'''
+
*'''approverEmail'''
*'''approverEmail'''
 +
*signatureHashAlgorithm (''sha1'' or ''sha2'' (default) for all certificate types. ''sha256-ecc-full'' or ''sha256-ecc-hybrid'' for Secure Site Pro and Secure Site Pro with EV certificates.)
 +
*[[API Format domainValidationMethods|domainValidationMethods]]
 +
*startProvision (0 (order won't be sent to CA, will be in status PAI. To request it use method modifySslCertRequest) or 1 (default, order will be requested in CA))
 +
*autorenew (''on'' or ''off'' (default))
 +
|- style="vertical-align:top;"
 +
|'''Parameters that must be sent with startProvision = 0'''
 +
|
 +
*'''domainAmount''' (amount of domains to buy)
 +
*'''wildcardDomainAmount''' (amount of wildcard domains to buy)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 38: Line 45:
     'period' => 2,
     'period' => 2,
     'csr' => '-----BEGIN CERTIFICATE REQUEST-----
     'csr' => '-----BEGIN CERTIFICATE REQUEST-----
-
MIIBvzCCASgCAQAwfzELMAkGA1UEBhMCTkwxCzAJBgNVBAgTAlpIMQ0wCwYDVQQH
+
MIIC1TCCAb0CAQAwgZExCzAJBgNVBAYMAk5MMRUwEwYDVQQIDAxadWlkLUhvbGxh
-
EwRSZGFtMQ8wDQYDVQQKEwZSb29yZGExHDAaBgNVBAMTE8d3dy5zaWVtZW5yb29y
+
bmQxEjAQBgNVBAcMCVJvdHRlcmRhbTEVMBMGA1UECgwMT3BlbnByb3ZpZGVyMQsw
-
ZGEubmwxJTAjBgkqhkiG9w0BCQEWFnNpZW1lbkBzbWVtZW5yb29yZGEubmwwgZ8w
+
CQYDVQQLDAJJVDETMBEGA1UEAwwKZG9tYWluLmNvbTEeMBwGCSqGSIb3DQEJAQwP
-
DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAKo5t1d4ka11M6NSUca2KBJS8d3a7lPh
+
aW5mb0Bkb21haW4uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-
7xlMAyNAvI68EQJEbPJ0UPxM9AiIS4HoVzXSGrP7lqwR8mQhM5HZkXAvvKfUnoN9
+
rdN8Ta644jvOk4neNzu09A7BiopEzAQ3u0zojrmo6cnbguoSAGrGnnnZEFsgH/07
-
BD4/k9Z/uErqtED/FQuOknmnHvgvAJewfTaaSN4+tbs1d54Yux9B/XeIhqyiWv9o
+
xCwAEJwzD7/7yNbpJNha6c0xToq4JERyeNn4SKiZmUrOHT65ntgeWXrhnkE59+N2
-
cRNh+gBMW8OLAgMBAAGgADANBgkqhkiG9w0BAQQFAAOBgQBFTxJ12R6juNaWQtmm
+
bVR0Ycaeuvs06Kg4ao5CTmLKS7LX5SCXS0aBX7tLnboWBxEOoYpAS1DkW4MKEiz1
-
JMWPrv0MDosDOIBZrCZoyF+VStANG8PoTg1VD7RgG+pZItCcp/X5MrHNsUUnySW5
+
0WURE+H0IAqkD8CO6yBz20bU94YkUeN4dZVjqLuuyZbVIGbyfr/fvtvb/Iql7Irc
-
kUaUx8Z21OOaoYjlHZTUaGfX5VKjjKH3NZ373Xms6Y9PcbX2nhvfo8IFSgnWKXD8
+
WgaJXg9+3iiq+zWgjEXcdLTp/aPIp0rj3kXOSkWglS6pK/LGIInSIXSH6TfsVYBK
-
7Vyp67kPlzocoO3rcGd+PmU/aQ==
+
YCbD8W+P7rj663GVrpyyBwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQCjXI6MY3W8
-
-----END CERTIFICATE REQUEST-----',
+
KNTbdmRwhCp8ZTUvU92h1+vnHapXJt2sCVBnxTP2SyoGZ+PIQt6iiwoxrw9ixGvh
 +
yAzh6iAZT1lUNSe/iJmoDR7wr7tiq4+RL7yJQ3mRE7bBJDsyQ9IbLYza6usfKKO5
 +
4qUtmtepvjpB1pw9aVT5uVUR+xBveIbLwDqyxLSwUcx+y/mPaAVR3PQxs4itXorj
 +
FEKnvCu6TL/xNIskQQPJXarEh2lBRg/wfJWRG/OemHrMsXKQ98uBT4MFaDR3hclQ
 +
ngqehHVrafmBtG+vQaTmHb9dWCW4IlluHj9lYBJ5h7igxGJR3cBQ9Srtl4zQdTFV
 +
cGo2g5Bg83cA
 +
-----END CERTIFICATE REQUEST-----',
     'softwareId' => 'linux',
     'softwareId' => 'linux',
     'organizationHandle' => 'GA003358-NL',
     'organizationHandle' => 'GA003358-NL',
-
    'administrativeHandle' => 'GA003358-NL',
 
     'technicalHandle' => 'GA003358-NL',
     'technicalHandle' => 'GA003358-NL',
-
    'billingHandle' => 'GA003358-NL',
 
     'approverEmail' => 'info@openprovider.nl'
     'approverEmail' => 'info@openprovider.nl'
     ));
     ));
===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 67: Line 79:
     <productId>5</productId>
     <productId>5</productId>
     <period>2</period>
     <period>2</period>
-
     <csr>-----BEGIN CERTIFICATE REQUEST-----
+
     <csr>-----BEGIN CERTIFICATE REQUEST---
-
MIIBvzCCASgCAQAwfzELMAkGA1UEBhMCTkwxCzAJBgNVBAgTAlpIMQ0wCwYDVQQH
+
    AwgZExCzAJBgNVBAYMAk5MMRUwEwYDVQQIDAxadWlkLUhvbGxh
-
EwRSZGFtMQ8wDQYDVQQKEwZSb29yZGExHDAaBgNVBAMTE8d3dy5zaWVtZW5yb29y
+
    bmQxEjAQBgNVBAcMCVJvdHRlcmRhbTEVMBMGA1UECgwMT3BlbnByb3ZpZGVyMQsw
-
ZGEubmwxJTAjBgkqhkiG9w0BCQEWFnNpZW1lbkBzbWVtZW5yb29yZGEubmwwgZ8w
+
    --trim-
-
DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAKo5t1d4ka11M6NSUca2KBJS8d3a7lPh
+
    4qUtmtepvjpB1pw9aVT5uVUR+xBveIbLwDqyxLSwUcx+y/mPaAVR3PQxs4itXorj
-
7xlMAyNAvI68EQJEbPJ0UPxM9AiIS4HoVzXSGrP7lqwR8mQhM5HZkXAvvKfUnoN9
+
    FEKnvCu6TL/xNIskQQPJXarEh2lBRg/wfJWRG/OemHrMsXKQ98uBT4MFaDR3hclQ
-
BD4/k9Z/uErqtED/FQuOknmnHvgvAJewfTaaSN4+tbs1d54Yux9B/XeIhqyiWv9o
+
    ngqehHVrafmBtG+vQaTmHb9dWCW4IlluHj9lYBJ5h7igxGJR3cBQ9Srtl4zQdTFV
-
cRNh+gBMW8OLAgMBAAGgADANBgkqhkiG9w0BAQQFAAOBgQBFTxJ12R6juNaWQtmm
+
      cGo2g5Bg83cA
-
JMWPrv0MDosDOIBZrCZoyF+VStANG8PoTg1VD7RgG+pZItCcp/X5MrHNsUUnySW5
+
      -----END CERTIFICATE REQUEST-----</csr>
-
kUaUx8Z21OOaoYjlHZTUaGfX5VKjjKH3NZ373Xms6Y9PcbX2nhvfo8IFSgnWKXD8
+
-
7Vyp67kPlzocoO3rcGd+PmU/aQ==
+
-
-----END CERTIFICATE REQUEST-----</csr>
+
     <softwareId>linux</softwareId>
     <softwareId>linux</softwareId>
     <organizationHandle>GA003358-NL</organizationHandle>
     <organizationHandle>GA003358-NL</organizationHandle>
-
    <administrativeHandle>GA003358-NL</administrativeHandle>
 
     <technicalHandle>GA003358-NL</technicalHandle>
     <technicalHandle>GA003358-NL</technicalHandle>
-
    <billingHandle>GA003358-NL</billingHandle>
 
     <approverEmail>info@openprovider.nl</approverEmail>
     <approverEmail>info@openprovider.nl</approverEmail>
   </createSslCertRequest>
   </createSslCertRequest>

Current revision as of 11:21, 11 December 2025

Contents

Module SSL certificates > Create Order

Module SSL certificates
Command name createSslCertRequest
Use Use this call to order a new SSL certificate
Input
  • productId
  • period
  • csr
  • softwareId (linux or windows)
  • hostNames
  • organizationHandle
  • technicalHandle
  • approverEmail
  • signatureHashAlgorithm (sha1 or sha2 (default) for all certificate types. sha256-ecc-full or sha256-ecc-hybrid for Secure Site Pro and Secure Site Pro with EV certificates.)
  • domainValidationMethods
  • startProvision (0 (order won't be sent to CA, will be in status PAI. To request it use method modifySslCertRequest) or 1 (default, order will be requested in CA))
  • autorenew (on or off (default))
Parameters that must be sent with startProvision = 0
  • domainAmount (amount of domains to buy)
  • wildcardDomainAmount (amount of wildcard domains to buy)
Output
  • id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createSslCertRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'productId' => 5,
    'period' => 2,
    'csr' => '-----BEGIN CERTIFICATE REQUEST-----

MIIC1TCCAb0CAQAwgZExCzAJBgNVBAYMAk5MMRUwEwYDVQQIDAxadWlkLUhvbGxh bmQxEjAQBgNVBAcMCVJvdHRlcmRhbTEVMBMGA1UECgwMT3BlbnByb3ZpZGVyMQsw CQYDVQQLDAJJVDETMBEGA1UEAwwKZG9tYWluLmNvbTEeMBwGCSqGSIb3DQEJAQwP aW5mb0Bkb21haW4uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA rdN8Ta644jvOk4neNzu09A7BiopEzAQ3u0zojrmo6cnbguoSAGrGnnnZEFsgH/07 xCwAEJwzD7/7yNbpJNha6c0xToq4JERyeNn4SKiZmUrOHT65ntgeWXrhnkE59+N2 bVR0Ycaeuvs06Kg4ao5CTmLKS7LX5SCXS0aBX7tLnboWBxEOoYpAS1DkW4MKEiz1 0WURE+H0IAqkD8CO6yBz20bU94YkUeN4dZVjqLuuyZbVIGbyfr/fvtvb/Iql7Irc WgaJXg9+3iiq+zWgjEXcdLTp/aPIp0rj3kXOSkWglS6pK/LGIInSIXSH6TfsVYBK YCbD8W+P7rj663GVrpyyBwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQCjXI6MY3W8 KNTbdmRwhCp8ZTUvU92h1+vnHapXJt2sCVBnxTP2SyoGZ+PIQt6iiwoxrw9ixGvh yAzh6iAZT1lUNSe/iJmoDR7wr7tiq4+RL7yJQ3mRE7bBJDsyQ9IbLYza6usfKKO5 4qUtmtepvjpB1pw9aVT5uVUR+xBveIbLwDqyxLSwUcx+y/mPaAVR3PQxs4itXorj FEKnvCu6TL/xNIskQQPJXarEh2lBRg/wfJWRG/OemHrMsXKQ98uBT4MFaDR3hclQ ngqehHVrafmBtG+vQaTmHb9dWCW4IlluHj9lYBJ5h7igxGJR3cBQ9Srtl4zQdTFV cGo2g5Bg83cA

END CERTIFICATE REQUEST-----', 
    'softwareId' => 'linux',
    'organizationHandle' => 'GA003358-NL',
    'technicalHandle' => 'GA003358-NL',
    'approverEmail' => 'info@openprovider.nl'
   ));

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>
  <createSslCertRequest>
    <productId>5</productId>
    <period>2</period>
    <csr>-----BEGIN CERTIFICATE REQUEST---
    AwgZExCzAJBgNVBAYMAk5MMRUwEwYDVQQIDAxadWlkLUhvbGxh
    bmQxEjAQBgNVBAcMCVJvdHRlcmRhbTEVMBMGA1UECgwMT3BlbnByb3ZpZGVyMQsw
    --trim-
    4qUtmtepvjpB1pw9aVT5uVUR+xBveIbLwDqyxLSwUcx+y/mPaAVR3PQxs4itXorj
    FEKnvCu6TL/xNIskQQPJXarEh2lBRg/wfJWRG/OemHrMsXKQ98uBT4MFaDR3hclQ
    ngqehHVrafmBtG+vQaTmHb9dWCW4IlluHj9lYBJ5h7igxGJR3cBQ9Srtl4zQdTFV
     cGo2g5Bg83cA
     -----END CERTIFICATE REQUEST-----</csr>
    <softwareId>linux</softwareId>
    <organizationHandle>GA003358-NL</organizationHandle>
    <technicalHandle>GA003358-NL</technicalHandle>
    <approverEmail>info@openprovider.nl</approverEmail>
  </createSslCertRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <id>2480</id>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_SSL_createSslCertRequest"
Views
Personal tools