stephenv / WearBucks-API

API for "WearBucks (Pay for Starbucks)" Android application

WearBucks API

WearBucks API is an open-source RESTful HTTP API for retrieving Starbucks user information. This is the API used by WearBucks (Pay for Starbucks) Android application on Google Play.

This API is based off Starbucks class by Neil.

Login information (username and password) is not stored and the API should only be used over SSL/TSL

Dependencies:

• Slim PHP Microframework
• Google Analytics (optional for usage statistics)
• MongoDB (optional for geolocation)
• Request body and response body use JSON

API Endpoints:

• POST /account
• POST /locations (In progress)

Installation instructions:

• Just deploy and modify the optional environment variables in "index.php" as necessary.
• Although the API is small, it was put together very quickly. It would be beneficial to look over the "Response codes & Error Handling" section as the API will always return HTTP 200 even when there are errors. Again, the "/locations" endpoint is currently in development and is not active.

POST /account

Retrieves Starbucks.com account details (given correct credentials)

Parameters

Name	Description	Details
username	Starbucks username or password	required
password	Starbucks password	required

Headers

Name	Description	Details
Content-Type	application/json	required
cid	Client UUID	optional, used by Google Analytics
av	App Version Number	optional, used by Google Analytics

Example JSON Request body:

{
  "username": "[e-mail]",
  "password": "******"
}

Example JSON Response body:

{
    "error": false,
    "customer_name": "Firstname Lastname",
    "stars": "0",
    "rewards": "0",
    "dollar_balance": "00.00",
}

Response codes & Error Handling

The API will always return an HTTP status code 200 however there may be errors. In the JSON response body, "error" will not be false. Example:

{
  "error":{
    "code": 401,
    "message": "Unauthorized",
    "description": "Authentication credentials were malformed or incorrect."
  }
}

Error codes:

• 400 Bad Request - Likely that the request was not formatted correctly
• 401 Unauthorized - Likely that the credentials were incorrect

POST /locations

NOTE: This API endpoint is in progress and therefore the documentation is not complete. Analytics is also currently not supported This feature returns a list of nearby Starbucks locations stored in a MongoDB database (not included in API). Set the following environment variables in index.php:

$_ENV['LOCATIONS'] = true;
$_ENV['MONGOHQ_URL'] = mongodb://user:[e-mail]/db_name;

Google Analytics

Google analytics can be enabled and is tracked using "Measurement Protocol". Ensure "Universal Analytics" is enabled on the property and use the provided tracking ID "UA-XXXX-XX".Set the following environment variables in index.php:

$_ENV['ANALYTICS'] = true;
$_ENV['TRACKING_ID'] = "UA-XXXXXXXX-X";