Ipoki API
The Ipoki API is available for non-commercial use by outside developers. If you want to use it for commercial purposes then you need to get our explicit approval.
| Plugin Methods | ||
| Method | Description | |
| signin.php | Users should be authenticated using the Ipoki plugin. Use this method to do it. | |
| Call | /signin.php?user=[username]&pass=[password]&ver=[optional plugin version] | |
| Return | echo 'CODIGO$$$'.[session id].'$$$'.[server URL].'$$$'.[0=no update, 1=optional update, 2=must update].'$$$' | |
| ear.php | Set the user's location. | |
| Call | /ear.php?iduser=[session id]&lat=[latitude]&lon=[logintude]&h=[altitude]&speed=[speed]& to=[to]&comment=[comment]&action=[action]&change=[status change] |
|
| Return | if ($alert) {echo 'ALERT$$$' . [alert text] . '$$$' . [URL] . '$$$' . [latitud] . '$$$' . [longitude] . '$$$' . [radio] . '$$$' . [username] . '$$$'; } else if ($comment) {echo 'COMMENT$$$' . [user] . '$$$' . [comment] . '$$$' . [action].'$$$';} else {echo 'OK'; } | |
| signout.php | Close the connection with the server. | |
| Call | /signout.php?iduser=" + [session id] | |
| Return | echo 'OK'; | |
| readposition.php | Get the location of a user. | |
| Call | /readposition.php?iduser=" + [session id] | |
| Return | (-999.999999,-999.999999) | |
| userstatus.php | Get the status of a user. | |
| Call | /userstatus.php?iduser=" + [session id] | |
| Return | echo '$$$'.[user status].'$$$'.{ON-OFF}.'$$$' | |
| myfriends.php | Get a list of friends for the calling user and their location. | |
| Call | /myfriends.php?iduser=" + [session id] | |
| Return | echo "$$$".[username]."$$$".[latitude]."$$$".[longitude]."$$$".[session key]; | |
| API Methods | ||
| Method | Description | |
| APIsignin.php | Users should be authenticated using the Ipoki API. Use this method to do it. | |
| Call | /APIsignin.php?user=[username]&pass=[password] | |
| Return | echo 'CODIGO$$$'.[session id].'$$$'.[server URL].'$$$' | |
| APIsignout.php | Close the connection with the server. | |
| Call | /APIsignout.php?iduser=" + [session id] | |
| Return | echo 'OK'; | |
| APIreadposition.php | Get the location of a user. | |
| Call | /APIreadposition.php?iduser=" + [session id] | |
| Return | (-999.999999,-999.999999) | |
| APIuserstatus.php | Get the status of a user. | |
| Call | /APIuserstatus.php?iduser=" + [session id] | |
| Return | echo '$$$'.[user status].'$$$'.{ON-OFF}.'$$$' | |
| APImyfriends.php | Get a list of friends for the calling user and their location. | |
| Call | /APImyfriends.php?iduser=" + [session id] | |
| Return | echo "$$$".[username]."$$$".[latitude]."$$$".[longitude]."$$$".[session key]; | |
If there are any other question or suggestion, please don't hesitate to send us an email developers@ipoki.com.