Skip to main content

Deep links

The deep links is a bridge between your game and the web hub environment you create with the Aghanim. When you integrate the deep links into your game, players can interact with the hub without separate authentication.

To use the deep links for player authentication:

  • Embed the links within your game interface.
  • Open the link page in the default browser, not in a webview.

It allows the players to discover the game hub and interact with it.

Default structure
https://<GAME_HUB_DOMAIN>/go/login?player_id=<UNIQUE_PLAYER_ID><QUERY_PARAMETERS?>
Structure for redeem code page
https://<GAME_HUB_DOMAIN>/go/redeem?player_id=<UNIQUE_PLAYER_ID><QUERY_PARAMETERS?>

Query parameters

To customize the deep links, add the query parameters you are interested in to the link.

player_id

Required

The Player ID used to auto authenticate the player into the game hub with the game credentials.

redirect_path

Optional

The game hub page to redirect the player to. To know what value the page has, use the template: /<PAGE_PATH_IN_HUB>.

code

Required for redeem code page

A redeem code that should be applied when a player follows the link.

locale

Optional

The language to display the game hub pages with. Use the ISO 639 format representation provided in the full list of supported languages.

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.

Example for News page of game hub
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.

Example for code redeem page of game hub
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.

Example for News page of Portuguese game hub
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=/news&locale=pt

Next to read

Need help?
Contact our integration team at integration@aghanim.com