xml-api avaliable yet ?

[jameshsi]

When reading http://www.cpanel.net/plugins/xmlapi...api__listaccts
I got a few questions:
1. Is this avaliable now ? Do I must have whm upgrade to version 11 to be able to use it ?

2. What is that "Calling this URL in WebHost Manager" means ? Can you make a example if I using php, how should I actually "call" it ?

[cPanelDavidG]

When reading http://www.cpanel.net/plugins/xmlapi...api__listaccts
I got a few questions:
1. Is this avaliable now ? Do I must have whm upgrade to version 11 to be able to use it ?

It is available for those running cPanel/WHM 11 (EDGE and CURRENT builds as of right now).

2. What is that "Calling this URL in WebHost Manager" means ? Can you make a example if I using php, how should I actually "call" it ?

It's actually pretty simple. Are you familiar with reading data from a URL in PHP? It's the same thing. When the documentation states call a URL, you are merely fetching data from a URL - that data being in XML format.

Example URL:
https://domain.com:2087/xml-api/setu...ob&makeowner=1

The parameters you pass depending on the API call, consult the API documentation for details. Essentially you are just opening that URL and the data returned will be the XML formatted information you are requesting (or status information for an action you have performed).

[jameshsi]

As always, cpanel always saving words when it comes to documentation, seems people in cpanel don't like to type more words. If you put something like "this documentation is only for WHM 11", we can save time to even try the xml-api.

[maxstudios]

As always, cpanel always saving words when it comes to documentation, seems people in cpanel don't like to type more words. If you put something like "this documentation is only for WHM 11", we can save time to even try the xml-api.

In addition to this.... can the cPanel doc guys produce a full list of usage commands which are implimented inside the api, from creation of an account (which exists) to changing a password (which doesnt)..

Cheers

[cPanelDavidG]

In addition to this.... can the cPanel doc guys produce a full list of usage commands which are implimented inside the api, from creation of an account (which exists) to changing a password (which doesnt)..

Cheers

You mean like http://www.cpanel.net/plugins/xmlapi/index.html ?

[maxstudios]

hi cPanelDavidG,

There are a few functions on there that there isnt any documentation for... for example passwd.

I know as cp11 is still under development but it would be handy to have.

Also, does the xml api still use the original authentication method.??....

Cheers

[cPanelDavidG]

hi cPanelDavidG,

There are a few functions on there that there isnt any documentation for... for example passwd.

I know as cp11 is still under development but it would be handy to have.

Also, does the xml api still use the original authentication method.??....

Cheers

I'll be sure to nag the folks that maintain our website once they're back in the office

The XML API uses the same authentication method (HTTP Authentication) as the WHM interface. As a result, you do not need a remote access key with the XML API.

[CoolMike]

The XML API uses the same authentication method (HTTP Authentication) as the WHM interface. As a result, you do not need a remote access key with the XML API.

Does this mean I can use this API only inside WHM? I can not use the api to create an account outside whm, for example integrated in my customer management scripts?

Michael

[cPanelDavidG]

Does this mean I can use this API only inside WHM? I can not use the api to create an account outside whm, for example integrated in my customer management scripts?

Michael

It wouldn't be much of an API (intended for third party scripts) if you could only use it inside WHM

You can call the entire URL directly (ex: https://sample.ext:2087/xml-api/list...e=user&search= ), and use whatever functions in the language you are using that handle HTTP Authentication to handle the HTTP Authentication properly

[CoolMike]

Thanks for the information, but why not using the remote access hash? I hate it, when I need to specify the root password in my php scripts.

[cPanelDavidG]

Thanks for the information, but why not using the remote access hash? I hate it, when I need to specify the root password in my php scripts.

I'd recommend creating a separate account with root-level privileges in WHM to avoid placing your root password in a PHP script.

[cpanelnick]

Thanks for the information, but why not using the remote access hash? I hate it, when I need to specify the root password in my php scripts.

The has will work as well.

[AlexAT]

You can call the entire URL directly (ex: https://sample.ext:2087/xml-api/list...e=user&search= ), and use whatever functions in the language you are using that handle HTTP Authentication to handle the HTTP Authentication properly

Why don't you be so kind to place PHP code showing the use of this method?
You did this for "cPanel::Accounting Modules" but seems XML API much powerfull.

[cPanelDavidG]

Why don't you be so kind to place PHP code showing the use of this method?
You did this for "cPanel::Accounting Modules" but seems XML API much powerfull.

Very quick and dirty PHP code for using the XML API from PHP:


$apiPath = "/xml-api/listaccts?searchtype=user&search=";

$result = file_get_contents("http://$user:$pass@localhost:2086$apiPath");

echo $result;

Be sure to set $user and $pass to your username and password.

I'd recommend you use https:// and port 2087 if that option is available to you on your servers

[AlexAT]

So simple
Will try, thank you!