How to set up program with Creator tag
How it works
Creator tag is a unique code that a player can receive when watching streams on YouTube or Twitch or in other formats/services. A player (supporter) can use this tag during in-game purchases to support their favorite influencer. The solution allows you to build trust and relationships with influencers and increase your income through attribution (tracking) of all in-game purchases.
Gamer flow
- The player copies the Creator tag or follows the link to connect it from the service where the influencer shared their code. An influencer can use the following services:
- Twitch
- YouTube
- Facebook Gaming
- other social networks
- The player enters the Creator tag in the field on the page where you implemented its connection. If the player clicks on the link, the Creator tag is automatically applied.
Monetization
You get income from all in-game purchases. A share of the influencer’s profit is deducted from each purchase, whose Creator tag was applied when making the purchase.
Note
The game platform and payment system may charge an additional commission on payments.
Who can use it
Partners who have a game with:
- an expected monthly income of at least $ 20,000
- goods available for purchase only within the game
How to get it
Set up program with Creator tag
To set up a program with a Creator tag:
- Send an application to csm@xsolla.com (or to bizdev@xsolla.com, if you are integrating an Xsolla product for the first time) and wait for its submission. Specify the following information in the application:
- Game name.
- Genre.
- Developer (optional).
- Publisher (optional).
- Official site of the game.
- Game description.
- Steam App ID (optional).
- Release date, if the game is still not published (optional).
- Link to promo materials (optional).
- Business model:
- premium
- free-to-play
- Game platform:
- PC
- Steam
- mobile
- web
- Program participation period.
- Revenue share percentage.
- End of revenue sharing. The day participating influencers stop receiving Revenue share.
- List of influencers. For each influencer, specify their email, social network channel and Creator tag. Consider the following limitations when choosing influencers:
- Withdrawal of funds from the balance is available only for influencers over 18 years old.
- Xsolla doesn’t work with influencers whose bank accounts are registered in countries that are subject to US sanctions.
- Implement the Creator tag connection mechanism by the player in one of the following ways:
- By clicking the link. In this case, the Creator tag value will be loaded into the specific input field automatically.
- Using manual input.
- Determine where the page with the Creator tag will be:
- in the game interface
- on the advertising game site
- in the payment interface every time the player pays for a purchase
Note
It is recommended to implement the Creator tag connection in the game interface so that the code is automatically applied to every player’s purchase.
- Send csm@xsolla.com a link to the page on which the Creator tag is connected (if the mechanism is implemented in the interface or on the game website).
- In the game, implement mechanisms for linking the Creator tag to the purchases of supporters, and tracking these purchases.
Manage program with Creator tag
To effectively manage a program with Creator tag:- Send your purchases to Xsolla regularly using the Creating transactions method. The recommended frequency for transmitting this data is once a day.
Note
In the case of a refund for a purchase that has the Creator tag applied, pass this information to Xsolla using the Canceling transactions method.
- Add new influencers to the program (optional).
Note
If you add influencers via Xsolla, regularly upload their list using the Getting influencers with Creator tag method. The recommended frequency of data acquisition is once a day.
- Using the Sending statistics by Creator tag method, transfer to Xsolla the information about statistics for supporters (optional).
Add influencers to program
You can add influencers to your program in one of the following ways:Self-add
To add influencers to your program yourself:- Call the Creating Creator tag for influencer and Adding influencer to program methods sequentially.
- To invite an influencer to the program, send a message to influencer@xsolla.com with the email, social network channel and Creator tag of the influencer used in the Creating Creator tag for influencer method.
Add via Xsolla
To add an influencer to the program via Xsolla, send a message to influencer@xsolla.com and specify the email, social network channel and Creator tag that you want to assign to the influencer.API methods for working with Creator tag
Getting influencers with Creator tag
Get a list of influencers in the program who have Creator tags.Parameter | Type | Description |
---|---|---|
| integer | Number of influencers in the list (by default: 20 , maximum: 100 ). |
| integer | Value of the offset that occurs when loading influencers in the list (by default: 0 ). |
Copy
- http
GET https://influencer.xsolla.com/api/partner/v2/programs/{PROGRAM_ID}/deals?limit=3&offset=0 HTTP/1.1
Creating transactions
Create/update transactions to which the Creator tag was applied. An array of the following objects is passed in the request body:Parameter | Type | Description |
---|---|---|
| string | Unique code of the influencer in the program. Required. |
| string | Transaction ID. Required. |
| string | Code of the currency in which the transaction was made. Three-letter currency code per ISO 4217. Required. |
| number | Transaction amount. Required. |
| string | Transaction date in the YYYY-MM-DD’T’HH:MM:SS format. Required. |
| string | Platform on which the transaction was made. Required. |
| string | Gamer ID. Required. |
| string | Purchased item ID. Required. |
| string | Purchased item name. Required. |
Copy
- http
PUT https://influencer.xsolla.com/api/partner/v2/programs/{PROGRAM_ID}/transactions HTTP/1.1
X-API-key: 7890ZYXWVUTSRQPONMLKJIHG
Content-Type: application/json
[
{
"transaction_id": "123456789",
"creator_tag": "creatorOne",
"platform_id": "steam",
"user_id": "0123456",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_1",
"item_name": "hk416",
"transaction_currency_code": "USD",
"transaction_value": 5
},
{
"transaction_id": "123456788",
"creator_tag": "creatorOne",
"platform_id": "steam",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_2",
"item_name": "hk416",
"transaction_currency_code": "EUR",
"transaction_value": 10
},
{
"transaction_id": "123456781",
"creator_tag": "creatorOne",
"platform_id": "xbox",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_1",
"item_name": "hk416",
"transaction_currency_code": "USD",
"transaction_value": 3
}
]
Canceling transactions
Cancel transactions to which Creator tag was applied. An array of the following objects is passed in the request body:Parameter | Type | Description |
---|---|---|
| string | ID of the transaction to be canceled. Required. |
| string | External ID of the payment refund. |
| string | Reason for the refund. |
| string | Refund date in the YYYY-MM-DD’T’HH:MM:SS format. Required. |
Copy
- http
PUT https://influencer.xsolla.com/api/partner/v2/programs/{PROGRAM_ID}/transactions HTTP/1.1
X-API-key: 7890ZYXWVUTSRQPONMLKJIHG
Content-Type: application/json
[
{
"transaction_id": "123456789",
"creator_tag": "creatorOne",
"platform_id": "steam",
"user_id": "0123456",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_1",
"item_name": "hk416",
"transaction_currency_code": "USD",
"transaction_value": 5
},
{
"transaction_id": "123456788",
"creator_tag": "creatorOne",
"platform_id": "steam",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_2",
"item_name": "hk416",
"transaction_currency_code": "EUR",
"transaction_value": 10
},
{
"transaction_id": "123456781",
"creator_tag": "creatorOne",
"platform_id": "xbox",
"transaction_date": "2020-04-10T06:06:24.830Z",
"item_id": "GAME_sku_1",
"item_name": "hk416",
"transaction_currency_code": "USD",
"transaction_value": 3
}
]
Sending statistics by Creator tag
Allow sending of statistics on the Creator tag connection of the influencer (by days). This information will be posted in the Statistics section in Influencer Account. An array of the following objects is passed in the request body:Parameter | Type | Description |
---|---|---|
| string | Date of transmission of creator statistics in the YYYY-MM-DD format. Required. |
| string | Unique code of the influencer in the program. Required. |
| integer | Number of new players who have used the Creator tag of the influencer. Required. |
| integer | Number of all players who have used the Creator tag of the influencer. Required. |
Copy
- http
PUT https://influencer.xsolla.com/api/partner/v2/programs/{PROGRAM_ID}/supporters HTTP/1.1
X-API-key: 7890ZYXWVUTSRQPONMLKJIHG
Content-Type: application/json
[
{
"date": "2020-04-10",
"creator_tag": "creatorOne",
"new_supporters": 125,
"total_supporters": 35900
},
{
"date": "2020-04-10",
"creator_tag": "creatorTwo",
"new_supporters": 123,
"total_supporters": 34567
}
]
Creating Creator tag for influencer
Allow creating of Creator tags for new influencers in the program. An array of the following objects is passed in the request body:Parameter | Type | Description |
---|---|---|
| string | Unique code of the influencer in the program. Required. |
| string | Influencer’s email. Required. |
| array of strings | Link to the influencer’s channel in the social network. There can be several channels. Required. |
Copy
- http
PUT https://influencer.xsolla.com/api/partner/v2/tags HTTP/1.1
X-API-key: 7890ZYXWVUTSRQPONMLKJIHG
Content-Type: application/json
{
"creator_tag": "creatorOne",
"creator_email": "influencer@example.com",
"creator_channels": [
"https://www.twitch.tv/creatorOne"
]
}
Adding influencer to program
Allow adding a new influencer to the program. An array of the following objects is passed in the request body:Parameter | Type | Description |
---|---|---|
| string | Unique code of the influencer in the program. Required. |
| integer | Percentage of profit the influencer earns for each purchase that their Creator tag has been applied to. Required. |
Copy
- http
PUT https://influencer.xsolla.com/api/partner/v2/tags HTTP/1.1
X-API-key: 7890ZYXWVUTSRQPONMLKJIHG
Content-Type: application/json
{
"creator_tag": "creatorOne",
"creator_email": "influencer@example.com",
"creator_channels": [
"https://www.twitch.tv/creatorOne"
]
}
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.