Deep links
How it works
Deep links allow users to open a launcher, or specific tab or page of the launcher from a browser. Some deep links enable you to transfer data from a browser to the game.
Note
Deep links have the following prerequisites:
- The launcher is installed on the user’s computer.
- The launcher has been opened by the user at least once.
How to get it
To open the launcher from a browser or external application, place one of the following links in the href attribute on the external resource, as indicated in the table below. In the links, <launcher-id>, <game-id>, and <tab-id> are identifiers of the launcher, game, and tab. To find their values:
- Open your project in Publisher Account.
- Click Launcher in the side menu.
- Find the launcher on the dashboard and click Edit launcher.
- Go to the Content section.
- Click Tabs.
- In the drop-down list to the right of the tab, click Edit.
- Copy the values from the URI of the tab editing page:
https://publisher.xsolla.com/<merchant-id>/projects/<project-id>/new-launcher/<launcher-id>/game/<game-id>/tabs/<tab-id>.
Note
If an invalid path is specified in the deep link, the deep link will either open the launcher or focus its window if the launcher is already open.
| Link | Description |
|---|---|
| xl-<launcher-id>://open | Opens the launcher or focuses its window if the launcher is already open. |
| xl-<launcher-id>://game/<game-id> | Opens the main game page. Supports data transfer from the browser to the game. |
| xl-<launcher-id>://game/<game-id>/news | Opens the game news tab or the main game page if the news page is unavailable. Supports data transfer from the browser to the game. |
| xl-<launcher-id>://game/<game-id>/store | Opens the game store tab or the main game page if the store is unavailable. Supports data transfer from the browser to the game. |
| xl-<launcher-id>://game/<game-id>/tab/<tab-id> | Opens a custom tab on the game page or the main game page if the custom tab is unavailable. Supports data transfer from the browser to the game. |
| xl-<launcher-id>://settings | Opens the launcher settings page. |
| xl-<launcher-id>://tab/<tab-id> | Opens a custom tab in the launcher or the main game page if the custom tab is unavailable. |
Copy
- html
<a href="xl-2484://settings">Open launcher-settings</a>
Was this article helpful?
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.Found a typo or other text error? Select the text and press Ctrl+Enter.
