API Module SSL modifySslCertRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module SSL certificates > Modify Order== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |SSL certificates |- style="background-color:#EEEEEE;"…')
 
(3 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Use this call to modify the domain validation settings of an SSL certificate order
+
|Use this call to modify parameters of the order in status PAI or to modify the domain validation settings of an SSL certificate order in the status REQ
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 16: Line 16:
*approverEmail
*approverEmail
*[[API Format domainValidationMethods|domainValidationMethods]]
*[[API Format domainValidationMethods|domainValidationMethods]]
 +
*startProvision (0 (default, order won't be sent to CA, will be in status PAI) or 1 (request order in CA))
 +
*autorenew (''on'' or ''off'' (default), available for PAI, REQ, ACT orders, will change value of the autorenew flag)
 +
|- style="vertical-align:top;"
 +
|'''Parameters that can be sent with startProvision = 0'''
 +
|
 +
*csr
 +
*softwareId (''linux'' or ''windows'')
 +
*[[API Format hostNames|hostNames]]
 +
*organizationHandle
 +
*technicalHandle
 +
*signatureHashAlgorithm (''sha1'' or ''sha2'' (default) for all certificate types. ''sha256-ecc-full'' or ''sha256-ecc-hybrid'' for Secure Site Pro and Scure Site Pro with EV certificates.)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 21: Line 32:
-
-
|}
|}
 +
 +
==Examples==
 +
===Using PHP class===
 +
$request = new OP_Request;
 +
$request->setCommand('modifySslCertRequest')
 +
  ->setAuth(array('username' => 'username', 'password' => 'password'))
 +
  ->setArgs(array(
 +
    'id' => 5,
 +
    'domainValidationMethods' => array(
 +
      array(
 +
        'hostName' => 'openprovider.nl',
 +
        'method' => 'admin@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>
 +
  <modifySslCertRequest>
 +
    <id>5</id>
 +
    <domainValidationMethods>
 +
      <array>
 +
        <item>
 +
          <hostName>openprovider.com</hostName>
 +
          <method>dns</method>
 +
        </item>
 +
      </array>
 +
    </domainValidationMethods>
 +
  </modifySslCertRequest>
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
    < code>0</code>
 +
    <desc />
 +
    <data>
 +
      <id>2480</id>
 +
    </data>
 +
  </reply>
 +
</openXML>

Current revision as of 09:23, 20 July 2016

Contents

Module SSL certificates > Modify Order

Module SSL certificates
Command name modifySslCertRequest
Use Use this call to modify parameters of the order in status PAI or to modify the domain validation settings of an SSL certificate order in the status REQ
Input
  • id
  • approverEmail
  • domainValidationMethods
  • startProvision (0 (default, order won't be sent to CA, will be in status PAI) or 1 (request order in CA))
  • autorenew (on or off (default), available for PAI, REQ, ACT orders, will change value of the autorenew flag)
Parameters that can be sent with startProvision = 0
  • csr
  • softwareId (linux or windows)
  • hostNames
  • organizationHandle
  • technicalHandle
  • signatureHashAlgorithm (sha1 or sha2 (default) for all certificate types. sha256-ecc-full or sha256-ecc-hybrid for Secure Site Pro and Scure Site Pro with EV certificates.)
Output

-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifySslCertRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'id' => 5,
    'domainValidationMethods' => array(
      array(
        'hostName' => 'openprovider.nl',
        'method' => 'admin@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>
  <modifySslCertRequest>
    <id>5</id>
    <domainValidationMethods>
      <array>
        <item>
          <hostName>openprovider.com</hostName>
          <method>dns</method>
        </item>
      </array>
    </domainValidationMethods>
  </modifySslCertRequest>
</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_modifySslCertRequest"
Views
Personal tools