{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/live.json","auth":"never","settings":"","examples":{"codes":[]},"method":"post","params":[{"name":"username","type":"string","default":"","desc":"This is the username for the customer account (generally a phone number in international format, excluding the + or 00)","required":true,"in":"body","ref":"","_id":"543eb372fd81651c008e4d50"},{"name":"password","type":"string","default":"","desc":"This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).","required":true,"in":"body","ref":"","_id":"57390fbb9042980e00ad1a8a"},{"name":"command","type":"string","default":"drivers","desc":"This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.","required":true,"in":"body","ref":"","_id":"543eb372fd81651c008e4d4f"},{"name":"uppercase","type":"boolean","default":"false","desc":"If TRUE, all keys are returned in uppercase.","required":false,"in":"body","ref":"","_id":"543eb372fd81651c008e4d4e"}],"results":{"codes":[{"language":"json","code":"{\n    \"error\": \"Authentication Failed\"\n}","name":"Failure"},{"code":"{\n  \"taxi_id\": \"134\",\n  \"lat\": \"43.066586\",\n  \"long\": \"-37.061775\",\n  \"first_name\": \"Mike\",\n  \"last_name\": \"Bloggs\",\n  \"status\": \"Busy\",\n  \"online\": \"Y\"\n},\n{\n  \"taxi_id\": \"543\",\n  \"lat\": \"43.102894\",\n  \"long\": \"-36.809235\",\n  \"first_name\": \"Adam\",\n  \"last_name\": \"Doe\",\n  \"status\": \"Away\",\n  \"online\": \"Y\"\n}","name":"Success","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Basic API Transaction","type":"endpoint","slug":"basic-api-transaction-2","excerpt":"","body":"An API Request contains the following:\n\n  * Connection Parameters\n  * User Parameters\n  * Parameters specific to the type of transaction, such as a new booking or cancellation. \n\nCurrently our API only supports name-value pairs via the POST/GET method.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57390e2d4dea9d0e000519af","createdAt":"2016-05-16T00:02:53.163Z","editedParams2":true,"__v":1,"editedParams":true,"githubsync":"","parentDoc":null,"project":"543005c87d487022005b3fa8","user":"543005a67d487022005b3fa7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36","5d1e4140522cd702b31b544b","5e321f8b5517b00012831b6a"],"_id":"543005c87d487022005b3fab","__v":8,"createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","project":"543005c87d487022005b3fa8"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Gazoop Customer API","slug":"iwebcab-customer-api","order":9999,"from_sync":false,"reference":false,"_id":"57390d0e1f4b740e00b06cb2","project":"543005c87d487022005b3fa8","__v":0,"createdAt":"2016-05-15T23:58:06.028Z","version":"543005c87d487022005b3fab"}}

postBasic API Transaction


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

username:
required
string
This is the username for the customer account (generally a phone number in international format, excluding the + or 00)
password:
required
string
This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).
command:
required
stringdrivers
This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.
uppercase:
booleanfalse
If TRUE, all keys are returned in uppercase.

Result Format


Documentation

An API Request contains the following: * Connection Parameters * User Parameters * Parameters specific to the type of transaction, such as a new booking or cancellation. Currently our API only supports name-value pairs via the POST/GET method.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}