Request Details
Method |
Controller |
Resource |
Parameters |
GET |
lib |
api |
|
Parameters Guide
Example Request Format
Direct Url |
https://api.beepxtra.com/lib/api |
Curl |
CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|lib" -X GET https://api.beepxtra.com/lib/api |
PHP SDK |
$beepapi->request('get', 'lib', 'api'); |
Sample Response
Success
{
"success":true,
"request":{
"method":"GET",
"controller":"lib",
"resource":"api",
"parameters":{
"\/lib\/api":""
},
"url_elements":[
"lib",
"api"
]
},
"error":{
"errorid":0,
"message":0
},
"data":[
{
"app_id":"3",
"module_id":"1",
"get":"1",
"post":"1",
"put":"1",
"delete":"0",
"other":"14",
"module":"user",
"params":null,
"description":"Coming soon"
},
{
"app_id":"3",
"module_id":"2",
"get":"1",
"post":"1",
"put":"1",
"delete":"0",
"other":"1,2,3,5",
"module":"card",
"params":null,
"description":"Coming soon"
},
...
]
}
Error
N/A
Response Guide
Parameter |
Type |
Details |
error |
String |
Contains the error message returned |
app_id |
int |
the Id of your API License in our system |
get |
boolean |
returns 1 for true, 0 for no access to request method |
post |
boolean |
returns 1 for true, 0 for no access to request method |
put |
boolean |
returns 1 for true, 0 for no access to request method |
delete |
boolean |
returns 1 for true, 0 for no access to request method |
other |
boolean |
returns 1 for true, 0 for no access to request method |
module |
string |
Returns the controller name |
params |
string |
Returns params datatypes where available or null |
description |
string |
Returns the controller description |