Please use the new documentation

This page is still here for now, but it will no longer be available from 31-Dec-2026. All content has moved to the new API documentation, which covers current features and new updates.

Go to the new documentation

API Module SSL retrieveOrderSslCertRequest

From Openprovider API documentation

Jump to: navigation, search

Contents

Module SSL certificates > Retrieve Order

Module SSL certificates
Command name retrieveOrderSslCertRequest
Use Returns information about an SSL certificate order
Input
  • id
Output
  • id
  • productId
  • commonName
  • productName
  • brandName
  • status
  • orderDate
  • activeDate
  • expirationDate
  • hostNames
  • organizationHandle
  • administrativeHandle
  • technicalHandle
  • billingHandle
  • emailApprover
  • emailReissue (only for cases where a reissue is requested and the CA wants to have this approved)
  • csr
  • period (the period of validity of the certificate)
  • software (linux or windows, as chosen during the order. Depending on this you will get a PEM or SPF format certificate)
  • certificate
  • intermediateCertificate
  • rootCertificate
  • vendorReferenceId (internal field)
  • vendorOrderId (order id at the Certificate Authority)
  • options (not yet used)
  • features (not yet used)
  • validationMethod (possible values: domain, organization, extended)
  • domainValidationMethods
  • domainValidationStatuses (internal statuses)
  • additionalData (provides additional data for DNS and HTTP validation methods)
    • Comodo (Sectigo) certificate - md5, sha1, sha256, fileLocation, fileContents (65 characters hash<break>comodoca.com<break>21 characters unique value), dnsRecord, dnsValue (33 characters hash<dot>33 characters hash<dot>21 characters unique value<dot>comodoca.com)
    • Symantec certificate - dns, file (name, content)
  • sslinhvaOrderId (internal field)
  • autorenew

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveOrderSslCertRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'id' => 1864
  ));

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>
  <retrieveOrderSslCertRequest>
    <id>1864</id>
  </retrieveOrderSslCertRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <id>1044</id>
      <commonName>openprovider.co.uk</commonName>
      <productName>Secure Site Pro with EV</productName>
      <brandName>VeriSign</brandName>
      <status>ACT</status>
      <orderDate>2009-02-13 13:22:48</orderDate>
      <activeDate>2009-02-21 15:51:23</activeDate>
      <expirationDate>2011-02-13 13:57:31</expirationDate>
      <hostNames></hostNames>
      <organizationHandle>SR003191-NL</organizationHandle>
      <administrativeHandle>SR001191-NL</administrativeHandle>
      <technicalHandle>SR003391-NL</technicalHandle>
      <billingHandle>SR003391-NL</billingHandle>
      <emailApprover>ssladmin@openprovider.nl</emailApprover>
      <csr>-----BEGIN CERTIFICATE REQUEST-----
MIIB2jCCAUMCAQAwgZkxCzAJBgNVBAYTAlNSMRMwEQYDVQQIEwpQYXJhbWFyaWJv
MRMwEQYDVQQHEwpQYXJhbWFyaWJvMRkwFwWDVQQKExBIb3N0aW5nIENvbmNlcHRz
MRswGQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8xKDAmBgkqhkiG9w0BCQEWGW5p
bm9uQGhvc3RpbmctY29uY2VwdHMubmwwgQ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
AoGBAK0WTGoqkJ6FXPquwObSUUAbSi4xaYEnFntObBK+q0lGOHiWIiFOueIfqg/y
c7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xCW+2xIIcYRDGmiqmus8Ed9wflrm7W5wFm
0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE41BQ3fInxFN9hzspjAgMBAAGgADANBgkq
hkiG9w0BAQUFAAOBgQBMWx/JmwvYqT7PnalI9KosOreIkr/6gc+UIIY1GX8KBBJ9
wxFBO6W8vgvy8vwrbOhJVXq1RUwqvCMJED061LxG9rQBkJ6coGMhLN8iT1xgRi9i
nwLcoimwyyGwMKNscIAKgeiKNpXhBRHyjOP+pXGeaTsWicctWKGe67kbPl/dbA==
-----END CERTIFICATE REQUEST-----</csr>
      <certificate>-----BEGIN CERTIFICATE-----
MIIDYTCCAsqgAwIBAgIDDxwJMA0GCSqGSIb3DQEBBQUAME4xCzAJBgNVBAYTAlVT
MRAwDgYDVQQKEwdFcXVpZmF4MS0wKwYDVQQLEyRFcXVpZmF4IFNlY3VyZSBDZXJ0
aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwMjAxMDA0MzU2WhcNMTEwMjAyMjEwMTQ2
WjCB6zEpMCcGA1UEBRMgTHNaN3FvREFGWG5wMmNtV3h1N2kxVmltaDhmLVJHaEgx
CzAJBgNVBAYTAlNSMRswGQYDVQQKExJ5d3cubmlub25hYmFzLmluZm8xEzARBgNV
BAsTCkdUNjQ3OTAwMTExMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29tL3Jl
c291cmNlcy9jcHMgKGMpMTAxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZhbGlk
YXRlZCAtIFJhcGlkU1NMKFIpMRswVQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8w
gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAK0WTGoqkJ6FXPquwObSUUAbSi4x
uYEnFntObBK+q0lGOHiWIiFOueIfqg/yc7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xC
W+2xIIcYRDGmiqmus8Ed9wflam7W5wFm0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE4
7BQ3fInxFN9hzspjAgMBAAGjga4wgaswDgYDVR0PAQH/BAQDAgTwMB0GA1UdDgQW
BBR1NEfvt2/xCmZNjSa1R6w+iPStsjA6BgNVHR8EMzAxMC+gLaArhilodHRwOi8v
Y3JsLmdlb3RydXN0LmNvbS9jcmxzL3NlY3VyZWNhLmNybDAfBgNVHSMEGDAWgBRI
5mj5K9KylddH2CMgEE8zmJCf1DAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUH
AwIwDQYJKoZIhvcNAQEFBQADgYEAQ+tAe6BZMwzciC6Y8vw1AXbXL8Oe1lKuI7ov
eGt30SQkVy3QRMSfbT7MQQy+cybE34xLY3GHXhTxV81d221eatgNRnz0lqg/RF5W
VbuD8DC8ZDclv0vd5aLK9SxlOP2VSqmJfgBBr4QVQ7igEue3s0jCzMch4v0j1Aap
OyY/SqY=
-----END CERTIFICATE-----</certificate>
      <intermediateCertificate>-----BEGIN CERTIFICATE-----
DFGKJLLDFomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJV
UzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2Vy
dGlmaWNhdGUgQXV0aG9yaXR5MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1
MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB0VxdWlmYXgxLTArBgNVBAsTJEVx
dWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCBnzANBgkqhkiG9w0B
AQEFAAOBjQAwgYkCgYEAwV2xWGcIYu3gmi0fCG2RFGiYCh7+2gRvE4RiIcPRfM6f
BeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+A
cJkVV5MW8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kC
AwEAAaOCAQkwggEFMHAGA1UdHwRpMGawZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQ
MA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlm
aWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQRDEwRDUkwxMBoGA1UdEAQTMBGBDzIwMTgw
ODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvSspXXR9gj
IBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQF
MAMBAf8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUA
A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
7qj/WsjTVbJmcVfewCHrPSqnI0kBBIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh
1voqZiegDfqnc1zqcPGUIWVEY/r87yloqaKHee9570+eF3Ds
-----END CERTIFICATE-----</intermediateCertificate>
      <rootCertificate>-----BEGIN CERTIFICATE-----
MIIDIDCCAomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJV
UzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2Vy
dGlmaWNhdGUgQXV0aG9yaXR5MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1
MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB0VxdWlmYXgxLTArBgNVBAsTJEVx
dWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCBnzANBgkqhkiG9w0B
AQEFAAOBjQAwgYkCgYEAwV2xWGcIYu3gmi0fCG2RFGiYCh7+2gRvE4RiIcPRfM6f
BeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+A
cJkVV5MW8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kC
AwEAAaOCAQkwggEFMHAGA1UdHwRpMGawZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQ
MA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlm
aWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQRDEwRDUkwxMBoGA1UdEAQTMBGBDzIwMTgw
ODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvSspXXR9gj
IBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQF
MAMBAf8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUA
A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
7qj/WsjTVbJmcVfewCHrPSqnI0kBBIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh
1voqZiegDfqnc1zqcPGUIWVEY/r87yloqaKHee9570+sB3c4
-----END CERTIFICATE-----</rootCertificate>
      <autorenew>on</autorenew>
    </data>
  </reply>
</openXML>

Example of the response for additionalData for Comodo (Sectigo) certificate: 

 <additionalData>
   <array>
      <item>
         <md5>3eeb773a542f247c99348292612eb545</md5>
         <sha1>bbf760aa34f34dcaeb01a9bc1c8ee729a2cbd6f1198d16a4d6eb6c2e6ca396c6</sha1>
         <sha256>bbf760aa34f34dcaeb01a9bc1c8ee729a2cbd6f1198d16a4d6eb6c2e6ca396c6</sha256>
         <fileContents>bbf760aa34f34dcaeb01a9bc1c8ee729a2cbd6f1198d16a4d6eb6c2e6ca396c6\ncomodoca.com\nFSr22IX8Dde1PAqzPvBe</fileContents>
         <fileLocation>example.com/.well-known/pki-validation/3EEB773A542F247C99348292612EB545.txt</fileLocation>
         <domain>example.com</domain>
      </item>
   </array>
 </additionalData>

Example of the response for additionalData for Comodo (Sectigo) multi-domain certificate: 

 <additionalData>
   <array>
     <item>
       <md5>990def0862163bf175976daceb192883</md5>
       <sha1>abbadcf82b8e29d246017fec6c52e8dc3d763c840eac90b65b883772360a6d25</sha1>
       <sha256>abbadcf82b8e29d246017fec6c52e8dc3d763c840eac90b65b883772360a6d25</sha256>
       <fileContents>abbadcf82b8e29d246017fec6c52e8dc3d763c840eac90b65b883772360a6d25\ncomodoca.com\nNXl18ZS0Mzz8EImpRmKr</fileContents>
       <fileLocation>test.com/.well-known/pki-validation/990DEF0862163BF175976DACEB192883.txt</fileLocation>
       <domain>test.com</domain>
     </item>
     <item>
       <md5>990def0862163bf175976daceb192883</md5>
       <sha1>abbadcf82b8e29d246017fec6c52e8dc3d763c840eac90b65b883772360a6d25</sha1>
       <sha256>abbadcf82b8e29d246017fec6c52e8dc3d763c840eac90b65b883772360a6d25</sha256>
       <dnsValue>abbadcf82b8e29d246017fec6c52e8dc.3d763c840eac90b65b883772360a6d25.NXl18ZS0Mzz8EImpRmKr.comodoca.com</dnsValue>
       <dnsRecord>_990def0862163bf175976daceb192883.domain.com</dnsRecord>
       <domain>domain.com</domain>
     </item>
   </array>
 </additionalData>

Example of the response for additionalData for Symantec certificate

  • DNS validation 
  <additionalData>
     <dns>sxqfbs715hu5gt0dp5r14f79wct1acmh.openprovider.nl</dns>
  </additionalData>
  • HTTP validation 
  <additionalData>
     <file>
       <name>fileauth.txt</name>
       <content>201708280902132e3d1qcdgr9ll1cp4xxj3synrnnu2qkmbe3m6n58ms3do17d8g</content>
     </file>
  </additionalData>
Retrieved from "https://doc.openprovider.eu/API_Module_SSL_retrieveOrderSslCertRequest"
Views
Personal tools