Deep Linking
This guide outlines how to utilize deep links for inviting mobile players to your Aghanim-generated game hub. By integrating these links into your mobile game, players can engage with the web-based environment of your game without needing separate authorization.
Implementation of deep links
Deep links are embedded within your mobile game's interface, allowing players to discover and interact with them. These links serve as a bridge to the game hub, facilitating interactions within the game's web environment you create with Aghanim.
Upon selecting a deep link, players are redirected to a specific page on the game hub.
The structure of a deep link is as follows:
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>
The page should open in the default browser, not in a webview.
You can pass the following query parameters in the link:
| Parameter | Description | Required? |
|---|---|---|
player_id | Unique Player ID for automatic authentication of the player, eliminating the need for additional login steps. | Yes |
redirect_path | The game hub page to redirect the player to. | No |
code | A redeem code that should be applied when a player follows the link. | Yes, for the /go/redeem page |
locale | The language to display the game hub in, specified in ISO 639 format. The chosen language must be added to your game hub as per the instructions. | No |
Use cases
Redirecting to the News page
You can direct players to the game hub's news page, where they can read updates and potentially make purchases. Suitable locations for these links may include in-game banners, news sections, etc.
An example link for this purpose is:
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=/news
Auto-redeeming coupons
Deep links can also be used to navigate players to a coupon redemption page within the game hub, where a predefined redeem code is automatically applied. This feature allows players to receive free items without manual code entry. Such links are ideal for promoting special offers or rewards within the game.
For example:
https://<GAME_HUB_URL>/go/redeem?player_id=<UNIQUE_PLAYER_ID>&code=<REDEEM_CODE>
When a player uses this link and the redeem code is activated, a webhook notification is sent to your specified URL. This notification confirms the code's activation, allowing you to credit the corresponding item to the player's account.
Redirecting to the localized game hub
In the deep link, you can specify the language of the game hub to redirect the player to a localized version.
An example link for the Portuguese localized game hub, specifically for redirecting a player to the News page:
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=/news&locale=pt
Need help?
Contact our integration team at integration@aghanim.com