Widget API

From Help.baskethotel.com

(Difference between revisions)
Jump to: navigation, search
(National teams widgets)
Line 98: Line 98:
* [[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===

Revision as of 07:42, 25 May 2012

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;

All widgets

Game widgets

Standings widgets

Team widgets

Player widgets

Statistics widgets

National teams widgets

Various widgets

Personal tools