API Module SSL generateOtpTokenSslCertRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module SSL certificates > Generate Otp Token== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |SSL certificates |- style="background-color:#EE…')
 
(8 intermediate revisions not shown)
Line 8: Line 8:
|generateOtpTokenSslCertRequest
|generateOtpTokenSslCertRequest
|-
|-
-
|'''Use'''
+
|'''Use'''.
-
|Use this call to get one-time token to get end-user access to SSL certificate order in the SSL Panel
+
|Use this call to get one-time token to get end-user access to SSL certificate order in the SSL Panel. In the response you will get URL and token to use
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
-
*'''id'''
+
*'''id''' - order Id in the OP system
-
*approverEmail
+
-
*[[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;"
+
-
|'''Output'''
+
-
|
+
-
-
+
|}
|}
Line 36: Line 19:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('modifySslCertRequest')
+
  $request->setCommand('generateOtpTokenSslCertRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
     'id' => 5,
     'id' => 5,
-
    'domainValidationMethods' => array(
+
  ));
-
      array(
+
-
        'hostName' => 'openprovider.nl',
+
-
        'method' => 'admin@openprovider.nl'
+
-
      ),
+
-
    ),
+
-
    ));
+
===Raw XML===
===Raw XML===
Line 56: Line 33:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <modifySslCertRequest>
+
   <generateOtpTokenSslCertRequest>
     <id>5</id>
     <id>5</id>
-
    <domainValidationMethods>
+
   </generateOtpTokenSslCertRequest>
-
      <array>
+
-
        <item>
+
-
          <hostName>openprovider.com</hostName>
+
-
          <method>dns</method>
+
-
        </item>
+
-
      </array>
+
-
    </domainValidationMethods>
+
-
   </modifySslCertRequest>
+
  </openXML>
  </openXML>
Line 75: Line 44:
     <desc />
     <desc />
     <data>
     <data>
-
       <id>2480</id>
+
       <uri>https://sslpanel.io/auth-order-otp-token</uri>
 +
      <token>aqlFgU8wHHAD0fGCDvS2iUlsou5bq0LY</token>
 +
      <expireAt>2017-02-02 09:10:04</expireAt>
     </data>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>
 +
 +
Final URL for the end user access in this case will be https://sslpanel.io/auth-order-otp-token?token=aqlFgU8wHHAD0fGCDvS2iUlsou5bq0LY

Current revision as of 08:54, 2 November 2017

Contents

Module SSL certificates > Generate Otp Token

Module SSL certificates
Command name generateOtpTokenSslCertRequest
Use. Use this call to get one-time token to get end-user access to SSL certificate order in the SSL Panel. In the response you will get URL and token to use
Input
  • id - order Id in the OP system

Examples

Using PHP class

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

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>
  <generateOtpTokenSslCertRequest>
    <id>5</id>
  </generateOtpTokenSslCertRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <uri>https://sslpanel.io/auth-order-otp-token</uri>
      <token>aqlFgU8wHHAD0fGCDvS2iUlsou5bq0LY</token>
      <expireAt>2017-02-02 09:10:04</expireAt>
    </data>
  </reply>
</openXML>

Final URL for the end user access in this case will be https://sslpanel.io/auth-order-otp-token?token=aqlFgU8wHHAD0fGCDvS2iUlsou5bq0LY

Retrieved from "https://doc.openprovider.eu/API_Module_SSL_generateOtpTokenSslCertRequest"
Views
Personal tools