You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-4
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
1
# Gamification Server
2
2
3
-
Gamification-server provides a framework for providing awards/points to users or teams and can be operated either standalone or integrated with other web-based applications. Based on the notion of badges used within other gamification systems. The gamification-server is implemented as an Express.js web application, built by [DevLeague](http://www.devleague.com/).
3
+
Gamification-server provides a framework for providing awards/points to users or teams and can be operated either standalone or integrated with other web-based applications. Based on the notion of badges used within other gamification systems. The gamification-server is implemented as an Express.js web application. This gamification server was built by [DevLeague](http://www.devleague.com/).
4
4
5
5
6
6
## APIs and remote usage
7
7
8
8
Gamification-server is designed so that other sites can send in "signals" that are parsed through a rules engine and generate points and badges. Also, other sites and apps can pull in JSON to list badges that a user has.
9
9
10
+
10
11
### End Points
11
12
12
13
* GET `/api/player`
@@ -15,13 +16,16 @@ Returns an array of all the players
15
16
* POST `/api/player/new`
16
17
Creates a new player and returns the new player
17
18
18
-
* GET `/api/player/<PLAYER_ID>`
19
+
* GET `/api/player/id/<PLAYER_ID>`
20
+
Returns the player's current stats, badges and achievements
21
+
22
+
* GET `/api/player/name/<PLAYER_NAME>`
19
23
Returns the player's current stats, badges and achievements
20
24
21
-
* GET `/api/player/<PLAYER_ID>/badges`
25
+
* GET `/api/player/<PLAYER_NAME>/badges`
22
26
Returns all the badges
23
27
24
-
* POST `/api/player/<PLAYER_ID>/assign_badge`
28
+
* POST `/api/player/<PLAYER_NAME>/assign_badge`
25
29
Creates a new badge for the player and returns an array of all the players badges.
0 commit comments