API License Module createPleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
m (→Using PHP class)
 
(21 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Licenses > Create License==
+
==License Module > Create License==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
|'''Module'''
|'''Module'''
-
|Licenses
+
|License
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
-
|createLicenseRequest
+
| createPleskLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''title'''
+
*'''title''' ''text''
-
*comment
+
*'''comment''' ''text''
-
*'''productId'''
+
*'''[[API Format License Options##License_items_for_Plesk|items]]''' ''License Items for Plesk''
-
*'''[[API Format License Options|options]]'''
+
*'''[[API Format License Options#License_features|features]]''' ''Features for Plesk''
 +
*'''[[API Format License Options#License_features|attachedKeys]]''' ''Third-party extension keys''
 +
*'''parentKeyId''' ''key number of a parent license(optional)''
 +
*'''period''' = ''1, 12, 24''
 +
*'''ipAddressBinding''' ''ipv4/ipv6 address''
 +
*'''restrictIPBinding''' ''true | false''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 26: Line 31:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('createLicenseRequest')
+
  $request->setCommand('createPleskLicenseRequest')
-
  ->setAuth(array('username' => 'username', 'password' => 'password'))
+
    ->setAuth(['username' => 'username', 'hash' => 'hash'])
-
  ->setArgs(array(
+
    ->setArgs([
-
      'productId' => 4,
+
            'period' => 1,
-
      'title' => 'Linux server APOLLO',
+
            'title' => 'Plesk Web Admin with features',
-
      'options' => array(
+
            'items' => [
-
        'keyType' => 'PLESK9WIN',
+
                'PLESK-12-WEB-ADMIN-1M',
-
        'domains' => 30,
+
                'FT-PLESK-DEVELOPER-PACK-1M',
-
        'features' => array('POWERPACK'),
+
                'FT-PLESK-WPB-10-SITES-1M',
-
        'period' => 12
+
                'FT-PLESK-DISABLE-SITEBUILDER',
-
      )
+
                'FT-PLESK-EMAIL-SECURITY-PACK-WITH-KASPERSKY-AV',
-
  ));
+
                'FT-PLESK-CLOUDFLARE-SERVERSHIELD-PLUS-ADVANCED',
 +
                'FT-PLESK-1-LANGUAGE-PACK-1M'
 +
            ],
 +
            'attachedKeys' => [
 +
                'ADD-DNSSEC-1M',
 +
                'ADD-ADDENDIO-DOCKER-BUSINESS-1M'
 +
            ],
 +
    ]);
===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>
-
  <credentials>
+
  <credentials>
-
    <username>username</username>
+
    <username>username</username>
-
    <password>password</password>
+
    <password>password</password>
-
  </credentials>
+
  </credentials>
-
  <createLicenseRequest>
+
  <createPleskLicenseRequest>
-
    <productId>4</productId>
+
    <title>Plesk Web Admin with features</title>
-
    <title>Linux server APOLLO</title>
+
    <period>1</period>
-
    <options>
+
    <items>
-
      <keyType>PLESK9WIN</keyType>
+
        <array>
-
      <domains>30</domains>
+
      <item>PLESK-12-WEB-ADMIN-1M</item>
-
      <features>
+
      <item>FT-PLESK-DEVELOPER-PACK-1M</item>
-
        <array>
+
      <item>FT-PLESK-WPB-10-SITES-1M</item>
-
          <item>POWERPACK</item>
+
      <item>FT-PLESK-1-LANGUAGE-PACK-1M</item>
-
        </array>
+
      <item>FT-PLESK-DISABLE-SITEBUILDER</item>
-
      </features>
+
      <item>FT-PLESK-EMAIL-SECURITY-PACK-WITH-KASPERSKY-AV</item>
-
      <period>12</period>
+
      <item>FT-PLESK-CLOUDFLARE-SERVERSHIELD-PLUS-ADVANCED</item>
-
    </options>
+
        </array>
-
  </createLicenseRequest>
+
    </items>
 +
    <attachedKeys>
 +
        <array>
 +
            <item>ADD-DNSSEC-1M</item>
 +
            <item>ADD-ADDENDIO-DOCKER-BUSINESS-1M</item>
 +
        </array>
 +
    </attachedKeys>
 +
    <restrictIPBinding>true</restrictIPBinding>
 +
  </createPleskLicenseRequest>
  </openXML>
  </openXML>
Line 68: Line 89:
     <desc />
     <desc />
     <data>
     <data>
-
       <id>1446</id>
+
       <id>236278</id>
     </data>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Current revision as of 12:23, 13 September 2018

Contents

License Module > Create License

Module License
Command name createPleskLicenseRequest
Use Order a new license
Input
  • title text
  • comment text
  • items License Items for Plesk
  • features Features for Plesk
  • attachedKeys Third-party extension keys
  • parentKeyId key number of a parent license(optional)
  • period = 1, 12, 24
  • ipAddressBinding ipv4/ipv6 address
  • restrictIPBinding true | false
Output
  • id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createPleskLicenseRequest')
   ->setAuth(['username' => 'username', 'hash' => 'hash'])
   ->setArgs([
           'period' => 1,
           'title' => 'Plesk Web Admin with features',
           'items' => [
               'PLESK-12-WEB-ADMIN-1M',
               'FT-PLESK-DEVELOPER-PACK-1M',
               'FT-PLESK-WPB-10-SITES-1M',
               'FT-PLESK-DISABLE-SITEBUILDER',
               'FT-PLESK-EMAIL-SECURITY-PACK-WITH-KASPERSKY-AV',
               'FT-PLESK-CLOUDFLARE-SERVERSHIELD-PLUS-ADVANCED',
               'FT-PLESK-1-LANGUAGE-PACK-1M'
           ],
           'attachedKeys' => [
               'ADD-DNSSEC-1M',
               'ADD-ADDENDIO-DOCKER-BUSINESS-1M'
           ],
   ]);

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>
 <createPleskLicenseRequest>
   <title>Plesk Web Admin with features</title>
   <period>1</period>
   <items>
       <array>
     <item>PLESK-12-WEB-ADMIN-1M</item>
     <item>FT-PLESK-DEVELOPER-PACK-1M</item>
     <item>FT-PLESK-WPB-10-SITES-1M</item>
     <item>FT-PLESK-1-LANGUAGE-PACK-1M</item>
     <item>FT-PLESK-DISABLE-SITEBUILDER</item>
     <item>FT-PLESK-EMAIL-SECURITY-PACK-WITH-KASPERSKY-AV</item>
     <item>FT-PLESK-CLOUDFLARE-SERVERSHIELD-PLUS-ADVANCED</item>
       </array>
   </items>
   <attachedKeys>
       <array>
           <item>ADD-DNSSEC-1M</item>
           <item>ADD-ADDENDIO-DOCKER-BUSINESS-1M</item>
       </array>
   </attachedKeys>
   <restrictIPBinding>true</restrictIPBinding>
 </createPleskLicenseRequest>
</openXML>

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