Intro
A widget is loaded in an iframe by requesting a specific widget, using the client name and the widget name, as well as the resource ID for which the should display information. These parameters are specified in the URL path and/or query parameters, see the examples below.
The client name and widget name(s) are preconfigured/set when the widgets are configured, and the resource ID is dynamically set at each page load in the client application. This resource ID is either an Abios ID or a 3rd party ID that has been mapped to the Abios ID space. The resource ID could be a series, match, player or team ID (or something else) depending on the widget in question.
Requesting a widget
Example 1 - Using an Abios ID
If an Abios ID is used to load the widget, the URL would be on the following form:{base-url}/{client-name}/{widget-name}/{resource-id}
So for a client called esports-inc loading a widget called pre-series for series 349518 (an Abios ID), the iframe would be:<iframe src="https://widget.abiosgaming.com/esports-inc/pre-series/349518"></iframe>
base-url
The base URL for our widget service.
Only https://widget.abiosgaming.com is valid.
client-name
The name/slug of the client requesting the widget, this is used for identification purposes.
Example: esports-inc
widget-name
The name/slug of the widget that the client wants to load.
Example: pre-series
resource-id
The resource ID for which the client want to load the given widget.
Example: 349518
lang
Optional query parameter used to change language/localisation of all text in the widget. Not using it returns a widget in english.
Example value: fr_fr.json, it_it.json or nl_nl.json
Example 2 - Using a 3rd party ID
If a 3rd party ID is used to load the widget, the URL would be on the same basic form as the when using an Abios ID (above) but also include a parameter for the ID space used:{base-url}/{client-name}/{widget-name}/{resource-id}?id-space={3rd-party}
So for a client called esports-inc loading a widget called live-series for series 1823 (an Esports Inc ID), the iframe would be:<iframe src="https://widget.abiosgaming.com/esports-inc/pre-series/1823?id_space=esportsinc"></iframe>
base-url
The base URL for our widget service.
Only https://widget.abiosgaming.com is valid.
client-name
The name/slug of the client requesting the widget, this is used for identification purposes.
Example: esports-inc
widget-name
The name/slug of the widget that the client wants to load.
Example: live-series
resource-id
The resource ID for which the client want to load the given widget.
Example: 1823
id_space
Optional query parameter to specify he name/slug of the ID space to which the resource-id belongs.
Example value: esportsinc
lang
Optional query parameter used to change language/localisation of all text in the widget. Not using it returns a widget in english.
Example value: fr_fr.json, it_it.json or nl_nl.json
Embedding and showing result
All our widgets are fully responsive and work on desktop and mobile devices alike. To learn more about how to work with iframes, please have look at this documentation.
But as a high level example, the following iframe snippet:
<iframe src="https://widget.abiosgaming.com/esports-inc/live-series/349518"></iframe>
could render something like this:
