API Module License retrieveKeyPleskLicenseRequest

From Openprovider API documentation

Revision as of 11:14, 23 March 2012 (view source) WikiSysop (Talk | contribs) ← Older edit		Current revision as of 11:14, 5 September 2018 (view source) WikiSysop (Talk | contribs) m (moved API Module License retrieveKeyLicenseRequest to API Module License retrieveKeyPleskLicenseRequest)
(2 intermediate revisions not shown)
Line 1:		Line 1:
-	==Module Licenses > Retrieve Key==	+	==License Module > Retrieve Key==
	{| 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'''
-	|retrieveKeyLicenseRequest	+	|retrieveKeyPleskLicenseRequest
	|-		|-
	|'''Use'''		|'''Use'''
-	|Returns the license key for the requested license	+	|Returns [base64][https://en.wikipedia.org/wiki/Base64] encoded xml key for the requested license
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
	|		|
-	*'''id'''	+	*'''keyId'''
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
	|		|
-	*mainKey	+	base64 encoded xml
-	**keyNumber	+
-	**key	+
-	*avKey	+
-	**keyNumber	+
-	**key	+
	|}		|}
Line 42:		Line 37:
	<password>password</password>		<password>password</password>
	</credentials>		</credentials>
-	<retrieveKeyLicenseRequest>	+	<retrieveKeyPleskLicenseRequest>
-	<id>1446</id>	+	<keyId>04867003</keyId>
-	</retrieveKeyLicenseRequest>	+	</retrieveKeyPleskLicenseRequest>
	</openXML>		</openXML>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<openXML>		<openXML>
-	<reply>	+	<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
-	<desc />	+	<desc>
-	<data>	+	</desc>
-	<mainKey>	+	<data>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cGxlc2stdW5pZmllZDprZXkgeG1sbnM6cGxlc2stdW5pZmllZD0iaHR...
-	<key>PD94c...</key>	+	</data>
-	<keyNumber>PLSK.01489424</keyNumber>	+	</reply>
-	</mainKey>	+
-	</data>	+
-	</reply>	+
	</openXML>		</openXML>

---

Current revision as of 11:14, 5 September 2018

Contents 1 License Module > Retrieve Key 2 Examples 2.1 Using PHP class 2.2 Raw XML

License Module > Retrieve Key

Module	License
Command name	retrieveKeyPleskLicenseRequest
Use	Returns [base64][1] encoded xml key for the requested license
Input	keyId
Output	base64 encoded xml

Examples

Using PHP class

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

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>
  <retrieveKeyPleskLicenseRequest>
    <keyId>04867003</keyId>
  </retrieveKeyPleskLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
 <code>0</code>
 <desc>
 </desc>
<data>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cGxlc2stdW5pZmllZDprZXkgeG1sbnM6cGxlc2stdW5pZmllZD0iaHR...
</data>
</reply>
</openXML>