Add-ons

1. Overview

Add-ons are used to support 3rd party systems like game platforms, text moderation, etc. You can install or uninstall the add-on on the portal. Only installed add-ons work for your title region. You can also modify the parameters of the installed add-ons anytime. You should be careful to check the parameters before you save them since it will work soon after saving.

2. Add-on Category

There are several categories of add-ons:

1. Auth add-on

   Auth add-on is used to integrate 3rd-party authentication services for games like Steam, Epic, Xbox, Apple ID, etc. We also support account solution that encapsulates 3rd-party authentication, such as Tencent in-house INTL SDK. You may need to know how to implement the login flow on your client side. Here is the detailed manual for it.

   tip

   NOTE: Once you configured the auth add-on correctly, PGOS can verify the auth openID and token on the backend side. But before it works, you need to integrate the client SDK/API on the client side by yourself in advance.

2. Moderation add-on

   Moderation add-on is used to integrate 3rd-party content moderation services. Once you configured it correctly, it will work soon on the backend side. This add-on works for all UGC content filtering like chat messages, player names, etc.

3. Middleware add-on

   Middleware add-on is used to integrate 3rd-party middleware like IDIP/IDIP.

4. Payment add-on

   Payment add-on is used to integrate payment systems like Tencent Midas, Xsolla, etc.

3. Auth Add-on

3.1 Intl Auth (Player Network Authentication)

Field Description:

• Intl Game ID: The target Intl game id of current title region.
• Intl Backend Domain: The target Intl backend domain, for example: test.intlgame.com.
• Verify Login API Path: The target Intl verify login API path, for example: /v2/auth/verify_login.
• Intl SDK Key: The target Intl sdk key of current title region.
• Intl Server Key: The target Intl server key of current title region.

Further Reading:

• More detail about INTL Auth (Player Network Authentication)
• How to login PGOS with INTLSDK

3.2 WeGame Auth

Field Description:

• Game ID: The target wegame game id of current title region.
• Client ID: The target wegame client id of current title region.
• Client Secret Key: The target wegame client secret key of current title region.

Further Reading:

• What is WeGame
• How to login PGOS with WeGame

3.3 PlayFab Auth

Field Description:

• PlayFab Title ID : The target title id on PlayFab.

• PlayFab Secret Key: The secret key on PlayFab.

  How to get the PlayFab Secret Key:

  1. Log in to the PlayFab dashboard of your game: https://developer.playfab.com/en-US/my-games

  2. Enter Settings >Title settings:

     

  3. Click the Secret Keys tab to view the secret key:

     

Further Reading:

• More detail about PlayFab Auth
• How to login PGOS with PlayFab

3.4 Epic Auth

There is no field for Epic Auth.

Further Reading:

• More detail about Epic Auth
• How to login PGOS with Epic Auth

3.5 Steam Auth

Field Description:

• Game ID: The target game ID on Steam.

• Web API Key: The server key on Steam. Click here to get more information.

  How to get steam Web API Key:

  1. Log in to https://partner.steamgames.com/.

  2. Enter User & Permissions > Manage Groups.

     

  3. Click the group of your application.

     

  4. The Web API Key is on the right.

     

• Use In-Game Purchase Sandbox: For the in-game purchase sandbox, optional.

Further Reading:

• More detail about Steam Auth
• How to login PGOS with Steam Auth

3.6 XboxLive Auth

Field Description:

• XboxLive Title ID : The target decimal title id on XboxLive .

Further Reading:

• More detail about XboxLive Auth
• How to login PGOS with XboxLive Auth

3.7 PlayStationNetwork Auth

Field Description:

• PlayStationNetwork Client ID : The target client id on PlayStationNetwork.
• PlayStationNetwork Client Secret : The target client secret on PlayStationNetwork.
• PlayStationNetwork Environment : The target environment on PlayStationNetwork.

Further Reading:

• More detail about PlayStationNetwork Auth
• How to login PGOS with PlayStationNetwork Auth

tip

Since PGOS uses the PlayStation Auth Web API to conduct PlayStation authentication operations, and PlayStation requires that servers need to be added to the IP whitelist. If you want to use the Playstation add-on, please contact PGOS to obtain the IP information and then add it to the PlayStation IP whitelist.

3.8 Nintendo Auth

Field Description:

• Nintendo Application ID : The target application id on Nintendo.

Further Reading:

• More detail about Nintendo Auth
• How to login PGOS with Nintendo Auth

4. Moderation Add-on

4.1 Content Moderation

ACE SDK provides profanity-checking and filtering functionality ( User Input Service). PGOS adapted to the ACE SDK and provides an add-on to enable content moderation for related API.

4.1.1 Content Moderation Integration

You can set the content moderation configuration on the portal.

There are two different filter modes：

• Normal Mode: Different API calls behave differently when sensitive words are detected, please refer to the document to see the logic Related API and Profanity Handling.
• Strict Mode: When sensitive words are detected, all API calls will return an error.

4.1.2 Field Description

• Enabled: switch to enable content moderation.
• APP ID: IEGG UIC service APP ID of the game.
• APP KEY: IEGG UIC service APP KEY of the game.
• UIC Region: the region where content moderation services are used.
• Filter Mode: Different modes apply to different countries' policies.

4.1.3 Related API and Profanity Handling

API	Profanity Handling
SendInstantChatMsg SendPersonalTextMsg SendGroupTextMsg	In normal mode, when there are sensitive words, the API will directly filter the sensitive words and return success. The API call will return an error in strict mode if sensitive words are detected.
SetGroupDesc SetGroupAnnouncement	In normal mode, when input content is with sensitive words, the API will filter the sensitive words, return success, and also indicate there are sensitive words. The API calling will return an error in strict mode if sensitive words detected
SetMyName CreateParty CreateLobby EditLobbyInfo SetMyGroupNickName CreateGroup SetGroupName SetGroupMemberRemark	No matter what the filter mode is, when there are sensitive words, the API call will return an error. Please refer to the key error handling in the corresponding service manual for more details.

4.1.4 Reporting of TSS information

TSS needs to submit relevant information every time it detects, The way to report can view the document

4.2 Content Moderation Report

Only used for Tencent games released in China Mainland.

Field Description:

• CC ID: The ID of the game registered from the platform.

5. Middleware Add-on

5.1 IDIP

IDIP is a service that allows the interaction between the operation merchandising system and the core data of your game, which is deployed outside PGOS.

IDIP is commonly used in marketing services for the following purposes:

• Award player with items
• Query players' activities
• Ban or unban a player
• Send mail to players
• ......

In general, If you integrate IDIP directly, you need to implement an HTTP server that responds to IDIP requests.

However, If a game uses PGOS, we provide an adapter service to route all IDIP requests to the Virtual Server, so you can write Node.JS code to handle IDIP requests.

To integrate IDIP on PGOS, two things need to be done:

• Configure the PGOS Adapter with a secret key and paste the callback URL to the IDIP side.
• Write virtual server code to handle IDIP requests.

5.1.1 IDIP Integration Steps

Firstly, you need to register your game at the IDIP web portal.

Then three steps need to be done on the PGOS web portal:

1. Specify a virtual server function to use as an IDIP request handler.
2. Input the secret key, and ensure its value is the same as IDIP_sig_key configured on the IDIP Portal.
3. Copy and paste the Callback URL to the IDIP_server_info section on the IDIP Portal.

The last step is to handle IDIP requests in your virtual server functions according to the agreement of the IDIP Protocol

5.1.2 About Virtual Server

After the PGOS Adapter handles the signature verification logic in the IDIP protocol, developers are still required to implement service code to respond to IDIP requests. This code can be written in any programming language, as long as it can properly handle HTTP requests with the URL path /pgos_idip.

For guidance on implementing the Virtual Server, please refer to the documentation.

When PGOS receives a request from IDIP, it triggers a call to the Virtual Server. After the Virtual Server completes processing, PGOS records a log entry containing both the request and response details of the HTTP transaction. These logs can be viewed under the Add-ons/IDIP/Logs tab.

5.2 Player Credit

Only used for Tencent games released in China Mainland.

Field Description:

• Game ID: The ID of the game registered from the credit platform.
• Source: The registration source from the credit platform helper.
• TP Token: The TP Token is registered from the credit platform helper.
• Credit Chatting: The scene ID for chatting.
• Credit Friend: The scene ID for a friend.
• Credit Group: The scene ID for a group.
• Credit Player Info: The scene ID for player information.

5.3 GME

Field Description:

• GME App ID: The app ID generated by the GME platform.
• Permission Key: The permission key generated by the GME platform.
• GME Type: Choose the type for GME usage.

6. Third-party Payment Add-on

6.1 Xbox

You can upload Relying Party and Business Partner Certificate file to install. Please input file password if exist.

6.2 Midas Global

Games published by Tencent can use the payment service provided by Midas to implement the purchase of items or currency in PGOS. Refer to economy document to learn about the configuration and application of Midas Global Addon.