• The BIND DNS server has already been deprecated and removed from Plesk for Windows.
    If a Plesk for Windows server is still using BIND, the upgrade to Plesk Obsidian 18.0.70 will be unavailable until the administrator switches the DNS server to Microsoft DNS. We strongly recommend transitioning to Microsoft DNS within the next 6 weeks, before the Plesk 18.0.70 release.
  • The Horde component is removed from Plesk Installer. We recommend switching to another webmail software supported in Plesk.

Problems with plesk Api RPC

B

bibawa

Guest
Dear,

I'm new to plesk API, we want integrate our webshop with plesk. I read through the PLESK API documentation and found the PHP Code examples, I copied that script but that doesn't seems to work.
The script is looking like this:

Code:
<?php
 
/**
 * Reports error during API RPC request
 */
class ApiRequestException extends Exception {}
 
/**
 * Returns DOM object representing request for information about all available domains
 * @return DOMDocument
 */
 
function domainsInfoRequest()
{
      $xmldoc = new DomDocument('1.0', 'UTF-8');
      $xmldoc->formatOutput = true;
 
      // <packet>
      $packet = $xmldoc->createElement('packet');
      $packet->setAttribute('version', '1.6.2.0');
      $xmldoc->appendChild($packet);
 
      // <packet/domain>
      $domain = $xmldoc->createElement('domain');
      $packet->appendChild($domain);
 
      // <packet/domain/get>
      $get = $xmldoc->createElement('get');
      $domain->appendChild($get);
 
      // <packet/domain/get/filter>
      $filter = $xmldoc->createElement('filter');
      $get->appendChild($filter);
 
      // <packet/domain/get/dataset>
      $dataset = $xmldoc->createElement('dataset');
      $get->appendChild($dataset);
 
      // dataset elements
      $dataset->appendChild($xmldoc->createElement('hosting'));
      $dataset->appendChild($xmldoc->createElement('gen_info'));
 
      return $xmldoc;
}

/**
 * Prepares CURL to perform the Panel API request
 * @return resource
 */
function curlInit($host, $login, $password)
{
      $curl = curl_init();
      curl_setopt($curl, CURLOPT_URL, "https://{$host}:8443/enterprise/control/agent.php");
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($curl, CURLOPT_POST,           true);
      curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
      curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
      curl_setopt($curl, CURLOPT_HTTPHEADER,
             array("HTTP_AUTH_LOGIN: {$login}",
                    "HTTP_AUTH_PASSWD: {$password}",
                    "HTTP_PRETTY_PRINT: TRUE",
                    "Content-Type: text/xml")
      );
 
      return $curl;
}

/**
 * Performs a Panel API request, returns raw API response text
 *
 * @return string
 * @throws ApiRequestException
 */
function sendRequest($curl, $packet)
{
      curl_setopt($curl, CURLOPT_POSTFIELDS, $packet);
      $result = curl_exec($curl);
      if (curl_errno($curl)) {
             $errmsg  = curl_error($curl);
             $errcode = curl_errno($curl);
             curl_close($curl);
             throw new ApiRequestException($errmsg, $errcode);
      }
      curl_close($curl);
      return $result;
}
 
/**
 * Looks if API responded with correct data
 *
 * @return SimpleXMLElement
 * @throws ApiRequestException
 */
function parseResponse($response_string)
{
      $xml = new SimpleXMLElement($response_string);
      if (!is_a($xml, 'SimpleXMLElement'))
             throw new ApiRequestException("Cannot parse server response: {$response_string}");
      return $xml;
}

/**
 * Check data in API response
 * @return void
 * @throws ApiRequestException
 */
function checkResponse(SimpleXMLElement $response)
{
      $resultNode = $response->domain->get->result;
 
      // check if request was successful


      if ('error' == (string)$resultNode->status)
             throw new ApiRequestException("The Panel API returned an error: " . (string)$resultNode->result->errtext);
}
 
//
// int main()
//
$host = 'hostname';
$login = 'username';
$password = 'pa$$sword';
 
$curl = curlInit($host, $login, $password);
 
try {
 
      $response = sendRequest($curl, domainsInfoRequest()->saveXML());
      $responseXml = parseResponse($response);
      checkResponse($responseXml);
 
} catch (ApiRequestException $e) {
      echo $e;
      die();
}
 
// Explore the result
foreach ($responseXml->xpath('/packet/domain/get/result') as $resultNode) {
      echo "Domain id: " . (string)$resultNode->id . " ";
      echo (string)$resultNode->data->gen_info->name . " (" . (string)$resultNode->data->gen_info->dns_ip_address . ")\n";
}
 
?>

When I run that script I receive the following output:

exception 'ApiRequestException' with message 'couldn't connect to host' in /customers/domain/domain/httpd.www/subdir/plesktest.php:83 Stack trace: #0 /customers/domain/domain/httpd.www/subdir/plesktest.php(130): sendRequest(Resource id #1, '

Does anybody knows what's going wrong ?

With regards,

Steve Vos
 
OK,
THe problems seems that my host blocks outbound request to port 8443..
 
Back
Top