== api.help ==
==== Description ====
Retrieves help for specified API command
==== Input Parameters ====
<table>
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
<tr><td>cmd</td><td>String</td><td>Yes</td><td>Cmd Name</td></tr>
</table>
==== Return ====
<table>
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
<tr><td>help</td><td>string</td><td>Description for specified command</td></tr>
<tr><td>parrams</td><td>array</td><td>Array with list of params</td></tr>
</table>
==== Usage Example ====
```
<?php
$curl = new \Dinke\CurlHttpClient;
//setup payment url and timeout
$payment_url = 'https://dev-payment.datingvip.com/api.json';
$timeout = 30;
$curl->setCredentials('some-token', 'some-pass');
//generate post data
$post_data = array
(
'cmd' => 'api.help',
'data' => array('cmd' => 'api.help')
);
$response = $curl->sendPostData($payment_url, $post_data, null, $timeout);
if($response === false)
{
//handle errors
}
//decode json to get array
$response = json_decode($response, true);
var_dump($response);
?>
```
Excepted output after running this script should be:
```
array (size=1)
'result' =>
array (size=8)
'code' => int 700
'status' => string 'Action completed succesfully' (length=28)
'command' => string 'api.help' (length=8)
'result' =>
array (size=2)
'help' => string 'Retrieve help for specified API command' (length=39)
'params' =>
array (size=1)
'cmd' => string '(string) API command name' (length=25)
'request' =>
array (size=5)
'cmd' => string 'api.help' (length=8)
'data' =>
array (size=1)
'cmd' => string 'api.help' (length=8)
'token' => string 'some-token' (length=26)
'pass' => string 'some-pass' (length=32)
'prefixes' => string 'api' (length=3)
'ts' => int 1429543640
'origin_ip' => string '93.87.220.184' (length=13)
'errors' => null
```