API Details

Below, we list down each of the APIs along with the input and output parameters that the applications can call. Also, wherever required, we try to add comments/notes to explain the details.

The output of each of the API calls will contain a field status which can have two values:

error - if there was some error in executing the API call

ok - if there was NO error and everything proceeded as required.

In case of status=error, the details of the error will be encoded in another attribute in the output called error - generally, containing 3 fields:

code - numeric error code,

code_str - short human-readable string corresponding to the error code,

message - longer detailed error message.

Note

As of now, the DELETE APIs for any resource are NOT available; but will be provisioned in the near future.

Below are some examples that are independent of any module configuration and are applicable to all applications registered with Playblazer.

All examples below use cURL on a Linux box to call the API urls using JSON as the output format.

On a linux box, you can use your distribution’s package manager to install cURL.

For example, on Debian/Ubuntu, you can do:

sudo apt-get install curl

Whereas, on an RPM-based distribution (like RHEL, CentOS, Fedora), you can do:

sudo yum install curl

On Mac OS X, cURL is available in MacPorts. Explanation for using MacPorts is out of the scope of this document - please consult the MacPorts website for more details.

cURL is also available on Windows - please check the following links:

• http://curl.haxx.se/download.html#Win32 - for downloads for 32-bit Windows
• http://curl.haxx.se/download.html#Win64 - for downloads for 64-bit Windows

Examples

1. When no secret key is passed:

Sample URL call:

curl "http://api.playblazer.com/v1/app/1/leaderboards"

Sample output:

{
     "status": "error",
     "error": {
         "message": "Secret Key not passed",
         "code": -100,
         "code_str": "E_INVALID_REQUEST"
     }
}

2. When invalid secret key is passed:

Sample URL call:

curl "http://api.playblazer.com/v1/app/1/leaderboards?secret_key=1234"

Sample output:

{
     "status": "error",
     "error": {
         "message": "Invalid APP ID and/or secret key",
         "code": -100,
         "code_str": "E_INVALID_REQUEST"
     }
}

3. When the requested module is not enabled in the application:

Sample URL call:

curl "http://api.playblazer.com/v1/app/2/leaderboards?secret_key=1234"

Sample output:

{
     "status": "error",
     "error": {
         "message": "App 2 does not use leaderboards module",
         "code": -200,
         "code_str": "E_MOD_NOT_USED_BY_APP"
     }
}