API Specification Doc Version Date Author Description

Transcription

1 API Specification Doc Version Date Author Description Aug Initial draft

2 1. Login 1. Signup 2. Save Device Token 3. Get User Score 4. Get Seasons 5. Get All Animals 6. Get All Animaltypes 7. Get Animals by Types 8. Game Rules Attempt Scratch 9. Game Rules Spend Points 10. Get All Claims 11. Get All Scratch Games 12. Get All Nians 13. Get Merchants Index

3 14. Get Products For Merchants 15. Get Game Positions Points 16. Get All Weapon Names Conventions Codes

4 s 1. Login Authenticate user with his and password users/loginuser/ Object Type JSON " ": "password": 200 "status": true, "userobject": "id": "678", "password": "f91e15dbec69fc40f81f0876e ", "first_name": "Ravi", "last_name": "deshmukh", " ": "signup_date": " :07:39", "last_login_on": " :08:24", "phone_mobile": " ", "deleted": "N", "user_status": "A", "social_id": "",

5 "social_platform": " :07:39", "game_points": "60050", "redemption_points": "0", "diamond_points": "4", "referral_code": "6eGI", "message": "success" 1. Sign Up Creates New User /users/registeruser Object Type JSON " ": "first_name": "Ravi", "last_name": "deshmukh", "facebook_id": "1", "phone_mobile": " ", "password": "referral_code":"uken" 200

6 "status": true, "userobject": "id": "678", "password": "f91e15dbec69fc40f81f0876e ", "first_name": "Ravi", "last_name": "deshmukh", " ": "signup_date": " :07:39", "last_login_on": " :00:00", "phone_mobile": " ", "deleted": "N", "user_status": "A", "social_id": "", "social_platform": " :07:39", "game_points": "50000", "redemption_points": "0", "diamond_points": "0", "referral_code": "6eGI", "message": "Registration successfull" Conventions Glossary Client - Client application. - HTTP status code of response. All the possible responses are listed under s for each method. Only one of them is issued per request server. All response are in JSON format. All request parameters are mandatory unless explicitly marked as [optional] The type of values accepted for a request parameter are shown the the values column like this [10 <any number>].the symbol means OR. If the parameter is [optional], the default value is shown in blue bold text, as 10 is written in [10 <any number>].

7 Codes All status codes are standard HTTP status codes. The below ones are used in this API. 2XX - Success of some kind 4XX - Error occurred in client s part 5XX - Error occurred in server s part Code Description 200 OK 201 Created 202 Accepted ( accepted, and queued for execution) 400 Bad request 401 Authentication failure 403 Forbidden 404 Resource not found 405 Not Allowed 409 Conflict 412 Precondition Failed 413 Entity Too Large 500 Internal Server Error 501 Not Implemented 503 Service Unavailable

8 2. Save Device Token /users/savedevicetoken Object Type JSON "userid": "684", "devicetoken": "gcgccg", "platform": "status": true, "userid": "684", "message": "Device Registered successfully"

9 3. Get User Score /users/getuserscore Object Type JSON "userid": "656" 200 "message": "success", "status": true, "userscoreobject": "bombs": 0, "scentsticks": 0, "dice": 0, "cards": 0, "firecracker": 0, "tickets": 0, "gamepoints": , "redemptionpoints": 0, "diamondpoints": 68, "nians": [ "id": "1", "nian_name": "Nian 1", "id": "2",

10 ,,,,,,,,,,, "nian_name": "Nian 2" "id": "3", "nian_name": "Nian 3" "id": "4", "nian_name": "Nian 4" "id": "5", "nian_name": "Nian 5" "id": "6", "nian_name": "Nian 6" "id": "7", "nian_name": "Nian 7" "id": "8", "nian_name": "Nian 8" "id": "9", "nian_name": "Nian 9" "id": "10", "nian_name": "Nian 10" "id": "11", "nian_name": "Nian 11" "id": "12", "nian_name": "Nian 12"

11 ,,,,,,,,,,, "id": "13", "nian_name": "Nian 13" "id": "14", "nian_name": "Nian 14" "id": "15", "nian_name": "Nian 15" "id": "16", "nian_name": "Nian 16" "id": "17", "nian_name": "Nian 17" "id": "18", "nian_name": "Nian 18" "id": "19", "nian_name": "Nian 19" "id": "20", "nian_name": "Nian 20" "id": "21", "nian_name": "Nian 21" "id": "22", "nian_name": "Nian 22" "id": "23", "nian_name": "Nian 23"

12 ],,,,,, "id": "24", "nian_name": "Nian 24" "id": "25", "nian_name": "Nian 25" "id": "26", "nian_name": "Nian 26" "id": "27", "nian_name": "Nian 27" "id": "28", "nian_name": "Nian 28" "id": "29", "nian_name": "Nian 29" "id": "30", "nian_name": "Nian 30"

13 4. Get Seasons /animals/getseasons 200 "status": true, "seasons": [ "seasonid": "1", "seasonname": "Summer", "seasonid": "2", "seasonname": "Autumn", "seasonid": "3", "seasonname": "Winter", "seasonid": "4", "seasonname": "Spring", "seasonid": "5", "seasonname": "Christmas", "seasonid": "6", "seasonname": "Chinese New Year", "seasonid": "7", "seasonname": "Cool"

14 ], "message": "success" 5. Get All Animals /animals/getallanimals 200 "status": true, "animalslist": [ "animalid": "1", "animalname": "Rat", "animaltypeid": "2", "animalprice": "100", "picture": "uploads/images/rat.jpg", "animalid": "2", "animalname": "Ox", "animaltypeid": "5", "animalprice": "100", "picture": "uploads/images/ox.jpg", "animalid": "3", "animalname": "Tiger", "animaltypeid": "4", "animalprice": "100",

15 ,,,,,, "picture": "uploads/images/tiger.jpg" "animalid": "4", "animalname": "Rabbit", "animaltypeid": "3", "animalprice": "100", "picture": "uploads/images/rabbit.jpg" "animalid": "5", "animalname": "Dragon", "animaltypeid": "1", "animalprice": "100", "picture": "uploads/images/dragon.jpg" "animalid": "6", "animalname": "Snake", "animaltypeid": "4", "animalprice": "100", "picture": "uploads/images/snke.jpg" "animalid": "7", "animalname": "Horse", "animaltypeid": "2", "animalprice": "100", "picture": "uploads/images/horse.jpg" "animalid": "8", "animalname": "Goat", "animaltypeid": "4", "animalprice": "100", "picture": "uploads/images/goat.jpg" "animalid": "9", "animalname": "Monkey", "animaltypeid": "2", "animalprice": "100", "picture": "uploads/images/monkey.jpg"

16 ,,,,,,, "animalid": "10", "animalname": "Roaster", "animaltypeid": "5", "animalprice": "100", "picture": "uploads/images/roaster.jpg" "animalid": "11", "animalname": "Pig", "animaltypeid": "5", "animalprice": "100", "picture": "uploads/images/pig.jpg" "animalid": "12", "animalname": "Parrot", "animaltypeid": "6", "animalprice": "100", "picture": "uploads/images/parrot.jpg" "animalid": "13", "animalname": "Rabbit", "animaltypeid": "5", "animalprice": "100", "picture": "uploads/images/rabbit.jpg" "animalid": "14", "animalname": "Cat", "animaltypeid": "3", "animalprice": "100", "picture": "uploads/images/cat.jpg" "animalid": "15", "animalname": "Dog", "animaltypeid": "2", "animalprice": "100", "picture": "uploads/images/nn.jpg"

17 "animalid": "19", "animalname": "Test Animal Name", "animaltypeid": "1", "animalprice": "50", "picture": "uploads/images/testimage.jpg", "animalid": "18", "animalname": "tt", "animaltypeid": "1", "animalprice": "24", "picture": "uploads/images/testimage.jpg" ], "message": "success" 6. Get All Animaltypes /animals/getanimaltypes 200 "status": true, "animaltypes": [ "animaltypeid": "1", "animaltype": "Zodiac", "animaltypeid": "2",

18 "animaltype": "Horoscope", "animaltypeid": "3", "animaltype": "Pokemon", "animaltypeid": "4", "animaltype": "Far Cry", "animaltypeid": "5", "animaltype": "Counter Strike", "animaltypeid": "6", "animaltype": "NFS Most Wanted" ], "message": "success" 7. Get Animals by Types /animals/getanimalsbytype Object Type JSON "animaltypeid":1

19 200 "status": true, "animalslist": [ "animalid": "5", "animalname": "Dragon", "animaltypeid": "1", "animalprice": "100", "picture": "uploads/images/dragon.jpg", "animalid": "19", "animalname": "Test Animal Name", "animaltypeid": "1", "animalprice": "50", "picture": "uploads/images/testimage.jpg", "animalid": "18", "animalname": "tt", "animaltypeid": "1", "animalprice": "24", "picture": "uploads/images/testimage.jpg" ], "message": "success" 8. Game Rules Attempt Scratch /gamerules/attemptscratch

20 Object Type JSON "userid":656, "gameid":2 200 "status": true, "gamepointsleft": "178054", "gamepointsdeducted": "50", "message": "Success" 9. Game Rules Spend Points /gamerules/spendpoints Object Type JSON "userid":656, "gamepoints":100, "diamondpoints":2, "bombs":40, "scentsticks":2,

21 "dice":100, "card":2, "firecracker":100, "tickets":2, "gameid":3 200 "status": true, "totalgamepointsafterclaim": "178254", "totaldiamondpointsafterclaim": "72", "message": "Success" 10. Get All Claims /gamerules/getallclaims Object Type JSON "userid":656

22 200 "status": true, "claims": [ "claim_id": "1", "claim_name": "Daily Claim Bonus", "game_points": "100", "redemption_points": "0", "diamond_points": "0", "claim_id": "2", "claim_name": "Random Bonus", "game_points": "50", "redemption_points": "0", "diamond_points": "0", "claim_id": "3", "claim_name": "Like us on Facebook", "game_points": "75", "redemption_points": "0", "diamond_points": "0", "claim_id": "4", "claim_name": "Join a Animal Scratch Game Community", "game_points": "150", "redemption_points": "0", "diamond_points": "0", "claim_id": "5", "claim_name": "Scratch 30 Cards today to earn Game Points", "game_points": "200", "redemption_points": "0", "diamond_points": "0" ], "message": "success"

23 11. Get All Scratch Games /gamerules/getallscratchgames Object Type JSON "userid": "status": true, "gp_requires_each_scratch": [ "id": "1", "scratch_game_name": "3 numbers to be indentical", "game_points_required_for_each_scratch": "100", "status": "1", "id": "2", "scratch_game_name": "Match 2 numbers", "game_points_required_for_each_scratch": "50",

24 ,,,,,,, "status": "1" "id": "3", "scratch_game_name": "3 numbers to be indentical 3", "game_points_required_for_each_scratch": "100", "status": "0" "id": "4", "scratch_game_name": "3 numbers to be indentical 4", "game_points_required_for_each_scratch": "100", "status": "0" "id": "5", "scratch_game_name": "3 numbers to be indentical 5", "game_points_required_for_each_scratch": "100", "status": "1" "id": "6", "scratch_game_name": "3 numbers to be indentical 6", "game_points_required_for_each_scratch": "100", "status": "0" "id": "7", "scratch_game_name": "3 numbers to be indentical 7", "game_points_required_for_each_scratch": "100", "status": "0" "id": "8", "scratch_game_name": "3 numbers to be indentical 8", "game_points_required_for_each_scratch": "100", "status": "1" "id": "9", "scratch_game_name": "3 numbers to be indentical 9", "game_points_required_for_each_scratch": "100", "status": "0"

25 , "id": "10", "scratch_game_name": "3 numbers to be indentical 10", "game_points_required_for_each_scratch": "100", "status": "0" ], "message": "success" 12. Get All Nians /gamerules/getallnians 200 "status": true, "nians": [ "id": "1", "nian_name": "Nian 1", "id": "2", "nian_name": "Nian 2", "id": "3", "nian_name": "Nian 3", "id": "4", "nian_name": "Nian 4"

26 ,,,,,,,,,,, "id": "5", "nian_name": "Nian 5" "id": "6", "nian_name": "Nian 6" "id": "7", "nian_name": "Nian 7" "id": "8", "nian_name": "Nian 8" "id": "9", "nian_name": "Nian 9" "id": "10", "nian_name": "Nian 10" "id": "11", "nian_name": "Nian 11" "id": "12", "nian_name": "Nian 12" "id": "13", "nian_name": "Nian 13" "id": "14", "nian_name": "Nian 14" "id": "15",

27 ,,,,,,,,,,, "nian_name": "Nian 15" "id": "16", "nian_name": "Nian 16" "id": "17", "nian_name": "Nian 17" "id": "18", "nian_name": "Nian 18" "id": "19", "nian_name": "Nian 19" "id": "20", "nian_name": "Nian 20" "id": "21", "nian_name": "Nian 21" "id": "22", "nian_name": "Nian 22" "id": "23", "nian_name": "Nian 23" "id": "24", "nian_name": "Nian 24" "id": "25", "nian_name": "Nian 25"

28 "id": "26", "nian_name": "Nian 26", "id": "27", "nian_name": "Nian 27", "id": "28", "nian_name": "Nian 28", "id": "29", "nian_name": "Nian 29", "id": "30", "nian_name": "Nian 30" ], "message": "success" 13. Get Merchants /merchants/getmerchants 200 "status": true, "merchants": [ "id": "1", "merchant_name": "Test Merchant",

29 " ": "password": "fbef a6496e902f1348eb91ee4", "address": "Kalyani Nagar", "contact_number": " ", "id": "10", "merchant_name": "Ravi Deshmukh", " ": "password": "fbef a6496e902f1348eb91ee4", "address": "address1", "contact_number": " " ], "message": "success" 14. Get Products for Merchants /merchants/getproductsformerchant Object Type JSON "merchantid":3 200 "status": true,

30 "products": [ "id": "3", "product_name": "Reebok Product 1", "product_price": "200", "product_description": "", "merchant_id": "10" ], "message": "success" 15. Get Game Position Points /gamestats/getgamepositionandpoints Object Type JSON "gameid":3, "userid": "status": true, "gamepointswithpositions": [ "position": "1", "game_points": "500000",

31 ,,,,,,,,, "has_user_achieved_position_in_past": false "position": "2", "game_points": "200000", "has_user_achieved_position_in_past": false "position": "3", "game_points": "100000", "has_user_achieved_position_in_past": true "position": "4", "game_points": "90000", "has_user_achieved_position_in_past": true "position": "5", "game_points": "80000", "has_user_achieved_position_in_past": true "position": "6", "game_points": "70000", "has_user_achieved_position_in_past": true "position": "7", "game_points": "60000", "has_user_achieved_position_in_past": true "position": "8", "game_points": "50000", "has_user_achieved_position_in_past": true "position": "9", "game_points": "40000", "has_user_achieved_position_in_past": true

32 "position": "10", "game_points": "30000", "has_user_achieved_position_in_past": true, "position": "11", "game_points": "20000", "has_user_achieved_position_in_past": true, "position": "12", "game_points": "10000", "has_user_achieved_position_in_past": true ], "message": "success" 16. Get All Weapon Names /gamestats/getallweaponnames 200 [,, "id": "1", "weapon_names": "Bomb" "id": "2", "weapon_names": "Scent Sticks" "id": "3",

33 ],,, "weapon_names": "Dice" "id": "4", "weapon_names": "Card" "id": "5", "weapon_names": "Fire Cracker" "id": "6", "weapon_names": "Tickets"