Lobby¶
This is the lobby module.
API: Get Opponents¶
Get Opponents API
URL: {BASE_URL}/app/<APP_ID>/lobby/<MODE>/<USER_ID>
Request Method: HTTP GET
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| APP_ID | Yes | Alpha-numeric | The application ID issued by the Playblazer platform when the app was created |
| secret_key | Yes | Alpha-numeric | The secret key issued by the Playblazer platform when the app was created |
| MODE | Yes | String | The mode for user ID interpretation |
| USER_ID | Yes | String | The user ID for whom the pairing needs to be generated. |
| compare | No | String | The param from profile score to use for comparison. Possible values:
Defaults to “level”. |
| delta | No | Numeric | The range [-delta, delta) of the “compare” parameter from user’s profile score. Default value = 3. For example, with “compare=level” and “delta=3”, the API will return list of users within [-3,3) neighbourhood of the user’s level. Similarly, with “compare=rp” and “delta=100”, the API will return list of users having “rp” in their profile scores within [-100,100) neighbourhood of calling user’s own “rp”. |
| start | No | Numeric | The start of the pagination |
| limit | No | Numeric | The no. of results to return in output |
| fmt | No | String | One of (json | xml) - the format of output |
In case of error, the output will contain “status=error” and error details encoded as explained earlier. If successful, the output will contain “status=ok” along with two lists:
- all (excluding the user issuing the request)
- friends
containing the primary details of the users along with their current status in the system.
The status of a user can be one of:
- unregistered - no profile of the user found - might need to be invited
- online - profile is found in the system and the user is currently online and available for pairing
- busy - profile is found in the system and the user is already active in another session - may or may not respond to the invite/challenge request
- offline - profile is found in the system, but the user is currently offline
all list contains the list of all the known/registered profile that have the id field corresponding to mode available.
friends list contains the list of social graph (if available) returned by the social media platform.
Since the ranges for “level” and “rp” can be quite different, we also support providing the range for comparison with the “delta” parameter to the API call.
Note
It is also possible to implement filters for these lists on specific criteria - like, “friends-only”, “non-friends/strangers only” etc.
However, it’s not yet implemented.
Example¶
URL Call:
curl "http://api.playblazer.com/v1/app/1/lobby/fb/kunalg?secret_key=cb8d878989b9478e96d1b1574a1bf4ec"
Output:
{
"status": "ok",
"all": {
"paging": {
"start": 10,
"limit": 10
},
"data": [
{
"status": "offline",
"profile_scores": {
"played": 88,
"level": 6,
"wins": 76,
"hp": 0,
"losses": 12,
"rp": 1300,
"xp": 0
},
"mode": "fb",
"id": "abcd"
},
{
"status": "offline",
"profile_scores": {
"played": 75,
"level": 5,
"wins": 60,
"hp": 0,
"losses": 15,
"rp": 655,
"xp": 0
},
"mode": "fb",
"id": "xxxxxxxxxxxxxxxx"
}
]
},
"friends": {
"paging": {
"start": 10,
"limit": 10
},
"data": [
{
"status": "offline",
"picture": {
"data": {
"url": "http://profile.ak.fbcdn.net/static-ak/rsrc.php/v2/yo/r/UlIqmHJn-SK.gif",
"is_silhouette": true
}
},
"first_name": "Kunal",
"name": "Kunal D.",
"id": "xxxxxxxxxxxxxxx"
},
{
"status": "unregistered",
"picture": {
"data": {
"url": "http://profile.ak.fbcdn.net/hprofile-ak-ash4/260685_627440784_1210904235_q.jpg",
"is_silhouette": false
}
},
"first_name": "Neetu",
"name": "Neetu G.",
"id": "xxxxxxxxxx"
},
{
"status": "unregistered",
"picture": {
"data": {
"url": "http://profile.ak.fbcdn.net/hprofile-ak-prn1/41380_835390240_1846_q.jpg",
"is_silhouette": false
}
},
"first_name": "Nikhil",
"name": "Nikhil S.",
"id": "xxxxxxxxxx"
},
{
"status": "unregistered",
"picture": {
"data": {
"url": "http://profile.ak.fbcdn.net/hprofile-ak-ash3/173355_100001471938169_7747184_q.jpg",
"is_silhouette": false
}
},
"first_name": "Anteema",
"name": "Anteema A.",
"id": "xxxxxxxxxxxxxx"
}
]
}
}
API: Get Random Opponents¶
Get Random Opponents API
URL: {BASE_URL}/app/<APP_ID>/lobby/<MODE>/<USER_ID>/random
Request Method: HTTP GET
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| APP_ID | Yes | Alpha-numeric | The application ID issued by the Playblazer platform when the app was created |
| secret_key | Yes | Alpha-numeric | The secret key issued by the Playblazer platform when the app was created |
| MODE | Yes | String | The mode for user ID interpretation |
| USER_ID | Yes | String | The user ID for whom the pairing needs to be generated. |
| compare | No | String | The param from profile score to use for comparison. Possible values:
Defaults to “level”. |
| delta | No | Numeric | The range [-delta, delta) of the “compare” parameter from user’s profile score. Default value = 3. For example, with “compare=level” and “delta=3”, the API will return list of users within [-3,3) neighbourhood of the user’s level. Similarly, with “compare=rp” and “delta=100”, the API will return list of users having “rp” in their profile scores within [-100,100) neighbourhood of calling user’s own “rp”. |
| epsilon | No | Numeric | The amount of change in delta if the list of random users does not contain enough (5) entries. Default value = 7 (since default “compare” is level and default “delta” is 3). This parameter specifies the amount by which the delta value should be ballooned so as to extend the range of search for random users - in case default params do not return enough results (5). For example, With “compare=level” and “delta=3”, if we find only 2 entries within the [3,-3) neighbourhood of the user’s level, with “epsilon=7”, the delta will be ballooned automatically to 10. That is, the search will be repeated as if “compare=level” and “delta=10” were passed - checking for users within [-10,10) neighbourhood of the user’s level. If that search also returns less than 5 entries, the search will be repeated with “delta=17” (i.e. within [-17,17) neighbourhood of user’s level). Such increments will be tried 10 times - if it still returns < 5 entries even after ballooning the delta 10 times, we give up and return whatever is found. Also, the lower bound for comparison will be ‘0’ - that is, it will not consider negative values. |
| limit | No | Numeric | The no. of results to return in output |
| exclude_friends | No | boolean (0/1) | Whether to exclude entries from the social graph from the search |
| fmt | No | String | One of (json | xml) - the format of output |
Example¶
With default arguments (compare=level, delta=3, epsilon=7) and user’s level=16, the following API call has covered the range [0,33) with 2 iterations.
URL Call:
curl "http://api.playblazer.com/app/1/lobby/fb/kunalg/random?secret_key=cb8d878989b9478e96d1b1574a1bf4ec"
Output:
{
"status": "ok",
"random": {
"data": [
{
"status": "offline",
"first_name": null,
"last_name": null,
"picture_url": null,
"mode": "email",
"profile_scores": {
"played": 0,
"level": 8,
"wins": 0,
"hp": 0,
"losses": 0,
"rp": 0,
"xp": 0
},
"id": "kunal.j.gangakhedkar@dialify.net"
},
{
"status": "offline",
"first_name": "Kunal",
"last_name": "Gangakhedkar",
"picture_url": null,
"mode": "email",
"profile_scores": {
"played": 138,
"level": 5,
"wins": 59,
"hp": 7,
"losses": 89,
"rp": 1300.66,
"xp": 60
},
"id": "kunal@playblazer.com"
},
{
"status": "offline",
"first_name": "Player4",
"last_name": null,
"picture_url": null,
"mode": "fb",
"profile_scores": {
"played": 2,
"level": 0,
"wins": 1,
"hp": 0,
"losses": 1,
"rp": 0,
"xp": 0
},
"id": "player4"
},
{
"status": "offline",
"first_name": "Player2",
"last_name": null,
"picture_url": null,
"mode": "fb",
"profile_scores": {
"played": 0,
"level": 0,
"wins": 0,
"hp": 0,
"losses": 0,
"rp": 0,
"xp": 0
},
"id": "player2"
},
{
"status": "offline",
"first_name": "Player1",
"last_name": null,
"picture_url": null,
"mode": "fb",
"profile_scores": {
"played": 0,
"level": 0,
"wins": 0,
"hp": 0,
"losses": 0,
"rp": 0,
"xp": 0
},
"id": "player1"
}
]
}
}