Phriction DatingVIP Public Payment Application Project API Documentation api.help History Version 3 vs 4
Version 3 vs 4
Version 3 vs 4
Content Changes
Content Changes
== 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
```
== 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 list of subscriptions' (length=30)
'params' =>
array (size=22)
'sub_id' => string '(int|array) Show results for specified subscription ID(s)' (length=57)
'item_id' => string '(int|array) Show results for specified item ID(s)' (length=49)
'page' => string '(int) Show only results on specified page' (length=41)
'limit' => string '(int) Restrict results per page' (length=31)
'on_date' => string '(string) Show results occured on specified date' (length=47)
'from_date' => string '(string) Show results from specified date' (length=41)
'to_date' => string '(string) Show results until specidied date' (length=42)
'from_id' => string '(int) Show results with ID(s) higher than specified' (length=51)
'to_id' => string '(int) Show results with ID(s) lower than specified' (length=50)
'nocache' => string '(bool) Choose whether results should be cached or not' (length=53)
'tracking_tag' => string '(int|array) Show results with specified client side tracking tag(s)' (length=67)
'tracking_order' => string '(int|array) Show results with specified client side order ID(s)' (length=63)
'currency' => string '(string|array) Show results with specified currency' (length=51)
'tracking_user' => string '(int|array) Show results with specified client side user ID(s)' (length=62)
'order_id' => string '(int|array) Show results with specified order ID(s)' (length=51)
'country' => string '(string|array) Show results having specified countries' (length=54)
'ip' => string '(string|array) Show only results having specified IP address(es)' (length=64)
'name' => string '(string*) Show only results having specified user name' (length=54)
'ccnum' => string '(string*) Show only results having specified credit card number part' (length=68)
'pp_type' => string '(string|array) Show results having specified processor type(s)' (length=62)
'rebill_count' => string '(int) Show results having specified nubmer of rebill count(s)' (length=61)
'email' => string '(string*) Show results having specified user email' (length=50)
'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
```
== 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 commandlist of subscriptions' (length=390)
'params' =>
array (size=1size=22)
'sub_id' => string '(int|array) Show results for specified subscription ID(s)' (length=57)
'item_id' => string '(int|array) Show results for specified item ID(s)' (length=49)
'page' => string '(int) Show only results on specified page' (length=41)
'limit' => string '(int) Restrict results per page' (length=31)
'on_date' => string '(string) Show results occured on specified date' (length=47)
'from_date' => string '(string) Show results from specified date' (length=41)
'to_date' => string '(string) Show results until specidied date' (length=42)
'from_id' => string '(int) Show results with ID(s) higher than specified' (length=51)
'to_id' => string '(int) Show results with ID(s) lower than specified' (length=50)
'nocache' => string '(bool) Choose whether results should be cached or not' (length=53)
'tracking_tag' => string '(int|array) Show results with specified client side tracking tag(s)' (length=67)
'tracking_order' => string '(int|array) Show results with specified client side order ID(s)' (length=63)
'currency' => string '(string|array) Show results with specified currency' (length=51)
'tracking_user' => string '(int|array) Show results with specified client side user ID(s)' (length=62)
'order_id' => string '(int|array) Show results with specified order ID(s)' (length=51)
'country' => string '(string|array) Show results having specified countries' (length=54)
'ip' => string '(string|array) Show only results having specified IP address(es)' (length=64)
'name' => string '(string*) Show only results having specified user name' (length=54)
'ccnum' => string '(string*) Show only results having specified credit card number part' (length=68)
'pp_type' => string '(string|array) Show results having specified processor type(s)' (length=62)
'rebill_count' => string '(int) Show results having specified nubmer of rebill count(s)' (length=61)
'cmd'email' => string '(string) API command name*) Show results having specified user email' (length=2550)
'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
```