API Help
1. HTTP Requests
Methods to retrieve data from the plerb API require a GET request, while methods that submit or change data requires a POST request.
2. Error Messages
If there is an error with your request, this is the response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>fail<status>
<error>
<message>[error message]</message>
</error>
</response>
If there is no error, this is the response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok<status>
</response>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>fail<status>
<error>
<message>[error message]</message>
</error>
</response>
If there is no error, this is the response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok<status>
</response>
3. Methods
verify credentials
Use this method to test a user's login credentials.
URL: http://plerb.com/api/account/verify_credentials/
Method: GET
Use this method to test a user's login credentials.
URL: http://plerb.com/api/account/verify_credentials/
Method: GET
Parameters:
authuser: user's username or email
authpass: user's password
api_key: your api key
authuser: user's username or email
authpass: user's password
api_key: your api key
update
Update a user's status by posting an update.
URL: http://plerb.com/api/statuses/update/
Method: POST
Update a user's status by posting an update.
URL: http://plerb.com/api/statuses/update/
Method: POST
Parameters:
authuser: user's username or email.
authpass: user's password.
status: message written by user, URL encode.
api_key: your api key.
authuser: user's username or email.
authpass: user's password.
status: message written by user, URL encode.
api_key: your api key.
4. API Key
Get an api key.
5. Additional information
If you have any questions, feel free to contact us at any time.