Vous êtes sur la page 1sur 7

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.

com

Technical Integration Guide


Document Version: 1.03 The following guide outlines ways you can integrate with the Leaderboarded service. This is a draft document and is subject to change.

Summary Architecture
The following summary architecture explains, at a high level, what services the Leaderboarded tool is providing and for whom:

From a Managers point of view: - The Leaderboarded tool allows the manager to combine a player list data source with data sources from other platforms. For example the player list might be derived from a Google spreadsheet list of players, uniquely identified by their twitter username while the external Data source might be Klout.

Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com Combining the two together creates a leaderboard of twitter users ranked by their Klout score. The Manager sets the release schedule (eg. Weekly) and every week Leaderboarded pulls in data from the sources and the list of players to create a leaderboard that is: o multi-variable more than one variable is combined to create a composite score for each player o relatively ranked players are ranked against each other o weighted each variable can be weighted separately On demand, release data is combined with an HTML template (using the template language explained in the next section) to produce the final HTML page

From the Player (end-user) point of view: - a player can see the leaderboard with themselves at the centre (if they are logged in) the player can navigate to see the global top 100 if required each player has a profile which determines the name, image and, in the future, summary text which is displayed to all. This also allows them to control notification settings from Leaderboarded such as whether to automatically post updates in their position to their followers using the profile screen a player can connect other social network profiles to their Leaderboarded player profile. This allows them, potentially, to increase their score by feeding in other data sources such as blogs and social networks like Twitter.

Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com The personal reporting screen shows the player how they are doing and allows them to benchmark their progress for example by showing change in rank between this week and last weeks leaderboard.

Integration Strategy
Leaderboarded integration is available at several levels: 1. Data In 2. Data Out 3. Leaderboard Design

Data In
In addition to our own platform connectors (full list) for social platforms such as Twitter, Yammer, Wordpress and so on, the Leaderboarded tool offers a way to import custom data in to your leaderboard via an instant Custom Data Connection.

Custom Data Connection


Feature availability: Bronze and above Custom Data Pull updates This approach entails providing Leaderboarded a JSON data feed that is always correct. At the time of Leaderboard release, Leaderboarded will poll this feed and use the data within. The feed should be structured as a JSON array as follows: { {key1:value, key2:value}, {key1:value, key2:value} } One of the keys must be a unique identifier for the player. Supported unique identifiers include: Twitter username Email address Player name (you are responsible for ensuring these are unique) To set up a custom data feed sign in as a leaderboard manager and create a data source of type Custom Data.
Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com

In the URL field enter the URL to your JSON feed.

Optionally you can secure your feed using HTTP Basic authentication. In which case Leaderboarded will send the relevant credentials when accessing your custom data feed. We would also recommend using SSL to secure your feed. The useragent is Leaderboarded 1.0. When the Manager creates the Leaderboard they will be able to select variables from your custom feed and add them to the leaderboard score with a weighting attached.

Custom Data Push updates - Your server sends updates to Leaderboarded server on a per player, or batch of players basis. - These scores are then stored in Leaderboarded database To do this please use the API as documented at http://docs.leaderboarded.apiary.io/ To set up a Push API as a data source note the following options: total Leaderboarded will total all scores during the data period for each player

Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com latest Leaderboarded will use the latest available score for each player difference Leaderboarded will use the difference between the first score for the period and the most recent score for the period.

Data Out
Feature availability: Bronze and above It is possible to embed the public leaderboard on an external web site. To do this Leaderboarded offers four mechanisms: 1. Use the standard Leaderboarded web page a. This is the most powerful as it gives players a page they can share on social media, ability to login and update their settings. b. You can theme this page using our powerful theme designer functionality 2. Embed via IFrame a. An iframe embeds a simple leaderboard by default. As a manager click on the embed on my website link to see the iframe embedding code. b. Advanced widgets are available to partner customers. Contact sales@leaderboarded.com for more. 3. Embed via Wordpress plugin a. The Leaderboarded wordpress plugin allows you to embed a leaderboard in either a post or page using a shortcode. 4. JSON data feed a. The leaderboard is also available as a JSON data feed. b. Please notify sales@leaderboarded.com if you wish to make use of the JSON data feed as the JSON feed is alpha functionality and subject to change.

Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com

Leaderboard Design
Customising the look and feel of your leaderboard is important to ensure it resonates with your players. Leaderboarded offers two design customisation options: 1. Leaderboarded standard template using your assets 2. Your own template with the leaderboard added in (available to customers with Palladium and above editions)

Leaderboard standard template


Leaderboard standard templates are professionally designed templates that are responsive and SEO friendly. Four templates are currently provided: 1. Playground an animated template designed for display on a plasma screen, such as in reception, the canteen or at an event 2. Cerulean, Designa and Definitive responsive templates designed for sharing and viewing online via the web. Standard templates can have the following additions as per the table below Template / Feature Cerulean, Designa, Definitive Custom Logo Yes Tweet feed No RSS images Yes RSS links Yes

Leaderboarded Ltd is a company registered in England & Wales number 4275579

Google Campus, 4-5 Bonhill Street, London EC2A 4BX 020 3286 1568 www.leaderboarded.com Playground Yes Yes Yes No

RSS images and RSS links are pulled in from a Tumblr blog RSS feed. More details on styling the standard templates with custom logos, css, js and rss feeds is available in the document "How to style your Leaderboard"

Your own template


In this case you provide the HTML page, with relevant CSS files, images and libraries. This is uploaded as a zip file to Leaderboarded. When the leaderboard is displayed, Leaderboarded replaces the Template Language Tag (TLT) with the appropriate HTML. For example: <h1>{board_name}</h1> Would insert the current leaderboard name into your heading tags: <h1>Gamification Gurus Leaderboard</h1> Full details of this process and a list of TLTs is available in the document Creating a theme with Leaderboarded http://www.scribd.com/doc/112566291/How-to-Create-a-Theme-onLeaderboarded

User Authentication
Leaderboarded supports the following mechanisms for user authentication: 1. Sign in via social network a. Using Oauth (twitter) and Oauth2 (yammer) users may login to their account using a social network credentials. b. Users link their social network credentials to the Leaderboarded player account via the profile page. c. Further social networks are under development including Facebook. 2. Sign in via email address a. Users may also create a username and password using their email address for signing in with. It may be possible to support other mechanisms of authentication for specific projects. Please contact your account manager or sales@leaderboarded.com to suggest your preferred mechanism.
Leaderboarded Ltd is a company registered in England & Wales number 4275579

Vous aimerez peut-être aussi