Crossplay Launcher Remote Launch API

Overview¶

The Crossplay Launcher Remote Execution API provides a function to query the list of running PCs and select a specific PC to remotely execute the game if the game is terminated unintentionally while running with the Crossplay Launcher.

It is largely composed of PC List Query API and PC Remote Execution API.

Prerequisites¶

• Windows version of Hive SDK v4.24.4.0 or higher
• Crossplay Launcher 1.0.16.0 or higher

Basic operation flow¶

• Set whether to use remote execution for each game

  Note

  Currently, only the manual setting of whether to use remote execution is supported, and the automatic setting function will be provided in the future.

• Run the game on a Windows PC via the Crossplay Launcher.

• Call the PC List Query API in the game to query the list of PCs running with the Crossplay Launcher.
• Call the PC Remote Run API with the information of the PC selected from the PC list as a result of the query.
  (External auto-login token is passed to the selected PC.)
• Reconnect to the game and auto-login using the external auto-login token from the Crossplay Launcher.

PC List Query API¶

This is an API that queries the list of PCs that are currently running with the Crossplay Launcher and are capable of remote execution.

Request URL and conditions¶

Request header¶

Request header sample¶

Content-Type : application/json
Authorization : Bearer b630b963152efa1f97a8c066831222

Request body¶

Request body sample¶

{
    "appId" : "com.com2us.hivesdk.normal.freefull.google.global.android.common",
    "playerId" : "20000023036",
    "did" : "304166094"
}

Response body¶

Response body sample¶

{
    "code": 100,
    "msg": "success",
    "data": [
        {
            "pc_name" : "pc1",
            "did" : "304162817",
        },
        {
            "pc_name" : "pc2",
            "did" : "304166094"
        },
        ...
    ]
}

Response code specification¶

PC Remote Execution API¶

This is an API that transmits token information to remotely execute a PC selected from the retrieved PC list after requesting the PC List Inquiry API.

Request URL and conditions¶

Request header¶

Request header¶

Request header sample¶

Content-Type : application/json
Authorization : Bearer b630b963152efa1f97a8c066831222

Request body¶

Request body sample¶

{
    "appId" : "com.com2us.hivesdk.normal.freefull.google.global.android.common",
    "playerId" : "20000023036",
    "did" : "304166094",
    "idpUserId" : "68261324",
    "idpIndex" : 1,
    "selected_did" : "304162817",
    "selected_pcName" : "pc1"
}

Response body¶

Response body sample¶

{
    "code" : 100,
    "msg" : "success"
}

Response code specification¶