Widget API

From Help.baskethotel.com

(Difference between revisions)
Jump to: navigation, search
(Using translations from another account)
(Player name formatting)
 
(6 intermediate revisions not shown)
Line 56: Line 56:
-
==== Using translations from another account ====
+
=== Using translations from another account ===
Sometimes it is necessary to use translations from another account of BasketHotel. Therefore widget config provides two options (both need to be set in this case):
Sometimes it is necessary to use translations from another account of BasketHotel. Therefore widget config provides two options (both need to be set in this case):
Line 70: Line 70:
MBT.API.translationsSetId = trSet;
MBT.API.translationsSetId = trSet;
</pre></code>
</pre></code>
 +
 +
=== Player name formatting ===
 +
 +
==== Order of first and last names ====
 +
 +
Widgets display first name before last name by default. If last name should be displayed before first name, please use this option:
 +
 +
<code><pre>
 +
MBT.API.ShowSurnameFirst = true;
 +
</pre></code>
 +
 +
==== First name priority ====
 +
 +
When short form of player name is used, full last name is displayed, and only first characted of first name is displayed. If last name should be shortened and first name should be displayed in full form, please use this option:
 +
 +
<code><pre>
 +
MBT.API.FirstNamePriority = true;
 +
</pre></code>
 +
 +
=== API ids instead of BHotel ones ===
 +
 +
It is possible to use api ids instead of bhotel ones in widget parameters and links. Currently supported parameters for ids conversion:
 +
* use_game_api_ids
==All widgets==
==All widgets==
Line 80: Line 103:
* [[Calendar widget]] - shows calendar with highlighted days when games are played
* [[Calendar widget]] - shows calendar with highlighted days when games are played
* [[Group results widget]] - shows table of group matches with results
* [[Group results widget]] - shows table of group matches with results
 +
* [[Game scroller widget]] - shows nearest games and lattest results in boxes which may be scrolled horizontaly
===Standings widgets===
===Standings widgets===
Line 104: Line 128:
* [[Scoring statistics widget]] - shows statistics based on game scores and quarter results
* [[Scoring statistics widget]] - shows statistics based on game scores and quarter results
* [[Last month efficiency leaders widget]] - shows efficiency leaders from the last month
* [[Last month efficiency leaders widget]] - shows efficiency leaders from the last month
 +
* [[Winning Percentage widget]] -
 +
* [[Attendance Full widget]] -
 +
* [[Attendance Top5 widget]] -
===National teams widgets===
===National teams widgets===
-
* [[National team widget]] - shown information and statistics of one national team
+
* [[National teams front page]] - shows summarized information about national teams.
-
* [[National team tournament]] - shown information and statistics of tournament national team has participated
+
* [[National teams players statistics]] - shows statistical leaders of national teams.
 +
* [[National team widget]] - shown information and statistics of one national team.
 +
* [[National team tournament]] - shown information and statistics of tournament national team has participated.
 +
* [[National teams games overview]] - shows overview of national teams games.
 +
* [[National team game card]] - shows information and statistics for single game.
 +
* [[National teams games and tournaments]] - shows list of national teams games and tournaments teams have participated.
 +
* [[National teams players]] - shows list of national teams players.
 +
* [[National team player]] - shows information and statistics of one national team player.
===Various widgets===
===Various widgets===
Line 114: Line 148:
* [[Club card widget]] - shows general information about club and its teams
* [[Club card widget]] - shows general information about club and its teams
* [[League selector widget]] - shows list of all leagues  
* [[League selector widget]] - shows list of all leagues  
 +
* [[Custom league selector widget]] - shows selected leagues across multiple client accounts
* [[Player records widget]] -
* [[Player records widget]] -
* [[Team records widget]] -
* [[Team records widget]] -
Line 121: Line 156:
* [[Arena widget]] - shows arena information and a map for the arena
* [[Arena widget]] - shows arena information and a map for the arena
* [[Referees and host teams]] - games list with assigned referees and host teams
* [[Referees and host teams]] - games list with assigned referees and host teams
 +
* [[Players top5 widget]] - show court with top5 players of game day or month

Latest revision as of 14:14, 17 January 2013

Contents

What are they?

BasketHotel widget is a piece of HTML hosted on MBT servers and embeddable into third party websites using BasketHotel Widgets Javascript API.

General information about API

Required knowledge to implement widget

Knowledge of HTML and Javascript is needed for developer to implement widgets on the website.

Widget API code

To use Widgets API you must acquire Widgets API Code from MBT. Widgets API Code is a unique identifier provided for you to use full capabilities of BasketHotel widgets on your site. Widgets API Code example: 2042ea315309ac8e8be9dca1f86f449d3e207dd5

Programming using Widgets API

Widgets API is exposed as a set of Javascript classes and constants. Widgets API should work correctly using Internet Explorer 7.0, Firefox 3.0, Opera 9.52, Safari 3, Google Chrome 1.0. Widgets API does not include any third party libraries so it is safe to use with different Javascript libraries.


Dynamic loading of scripts (recommended way)

Dynamic loading if recommended way because it tracks changes on MBT side and loads refreshed content into webpage containing widgets despite of proxy and/or browser cache. To use Widgets API include code block below in head part of your webpage.

<script type="text/javascript" src="http://beta.mbt.lt/~phx/bhotel_trunk/widget_host/version.php"></script>
<script type="text/javascript" src="http://beta.mbt.lt/~phx/bhotel_trunk/widget_host/static/scripts/api/loader.js"></script>
<script type="text/javascript">
var mbtWidgetMainScripts = [];
mbtWidgetMainScripts.push('http://widgets.baskethotel.com/static/scripts/api/api.js');
mbtWidgetsLoad(mbtWidgetMainScripts);
MBT.API.ApiId = "3beaba6f7666b0dd5ca4bc705a62c23c9d4e1efd";
</script>

MBT will provide you with the api id dedicated for you.

Static loading of scripts

To use Widgets API include code block below in head part of your webpage

<script type="text/javascript" src="http://widgets.baskethotel.com/static/scripts/api/api.js"></script>
<script type="text/javascript">
MBT.API.ApiId = "2042ea315309ac8e8be9dca1f86f449d3e207dd5";
</script>

MBT will provide you with the api id dedicated for you.

Setting season and league for widget

Most of the widgets require to have league or season to be set. It is done by passing season_id or league_id paramaters to widgets. If only league_id parameter is passed, default season is taken. If only season_id is passed, league_id is calculated automaticaly, this is possible because in BasketHotel all seasons are children of leagues, meaning "season 2010-2011" in "Mens league" and "season 2010-2011" in "Womens league" will completely differend season and will have differend ids. If both "season_id" and "league_id" will be passed to widget, one has to make sure, that season is a child for league set, otherwhise widget will throw an error.

Internationalization

Widgets data is available in multiple language if we have data in multiple languages. To set language assign two symbols language code to MBT.API.Lang constant.

Example:

MBT.API.Lang = "en";

Contact MBT to get information about multi language support.


Using translations from another account

Sometimes it is necessary to use translations from another account of BasketHotel. Therefore widget config provides two options (both need to be set in this case):

  1. translations_lang
  2. translations_set_id

Please not that not all phrases are translated to destination language.

These options can also be set for all widgets on page:

MBT.API.translationsLang = trLang;
MBT.API.translationsSetId = trSet;

Player name formatting

Order of first and last names

Widgets display first name before last name by default. If last name should be displayed before first name, please use this option:

MBT.API.ShowSurnameFirst = true;

First name priority

When short form of player name is used, full last name is displayed, and only first characted of first name is displayed. If last name should be shortened and first name should be displayed in full form, please use this option:

MBT.API.FirstNamePriority = true;

API ids instead of BHotel ones

It is possible to use api ids instead of bhotel ones in widget parameters and links. Currently supported parameters for ids conversion:

  • use_game_api_ids

All widgets

Game widgets

Standings widgets

Team widgets

Player widgets

Statistics widgets

National teams widgets

Various widgets

Personal tools