Extensions can obtain complete information and control over Plesk
entities (customer accounts, service plans, and so on) via the XML API
interface. This interface assumes exchanging operation requests wrapped
into XML-structured packets. Plesk receives such an XML-structured
operation request, processes it, and responds with a PHP class which
fields mimic the XML tree structure. The structure of the XML packets is
defined by the XML API protocol (refer to the XML API
Guide).
Every Plesk server supports a number of versions of XML API (for
backward compatibility). It is possible to send packets of a particular
XML API version by explicitly providing the protocol version. If you do
not specify the version, the most recent supported XML API version will
be used.
To perform an operation via XML API, use the
pm_ApiRpc
class. The used methods are:
Additionally, Plesk provides a PHP library that simplifies working with
XML API. This library can be used as an alternative or complementing the
method described here. See section Using XML API PHP
Library below for instructions on adding and using
the library in your extension.