General questions
Project settings
Do I need to create new projects for each environment (QA, staging, production)?
For testing, we recommend that you use separate projects to avoid affecting the production environment.
I am a mobile game developer. What should I specify as the website in the project settings?
Specify the URL of the game’s website or the URL of your company’s website.
How can I invite members of my company to give them access to my Publisher Account?
In your Publisher Account, go to the Company settings > Users and click Invite new user.
Where can I find the project ID?
Open your project in Publisher Account and go to the Project settings > General settings section.
Where can I find the merchant ID?
Open Publisher Account and go to the Company settings > Company section.
What is the difference between a secret key, project key, and API key?
A secret key and project key are the same. It is used for the digital signature that is required when processing secure payments. The request’s JSON body is concatenated with this key, and then the result is hashed with SHA-1.
The API key is used for API calls sent to the Xsolla server. This key must be held on your own server and never inside binary files or frontend. For more information about working with API keys, see the API reference.
What is the difference between a webhook URL and return URL?
A webhook URL is the URL address of your webhook server where notifications are sent. A return URL is the URL address where a user is redirected after completing a payment.
Where can I find the API Key?
API key is shown in Publisher Account only once when it is created and must be stored on your side. You can create a key in the following section:
For more information about working with API keys, see the API reference.
Key recommendations:
- Save the generated API key on your side. You can view the API key in Publisher Account only once when it is created.
- Keep your API key a secret. It provides access to your personal account and your projects in Publisher Account.
- The API key must be stored on your server and never in binaries or on the frontend.
If an API call you need does not contain the project_id path parameter, use the API key that is valid in all the company’s projects to set up authorization.
API and webhooks
What Xsolla API are available?
You can use the following API:
How to begin working with Xsolla API?
Refer to the introductory information.
Where can I find information about working with webhooks?
In the webhook documentation.
What Xsolla network IP addresses do I need to add to the allowlist to configure webhooks?
Refer to the webhooks documentation for the list of IP addresses from which webhooks are sent.
Do I need to use HTTPS for a webhook protocol?
Yes.
Why was Xsolla notification not sent to the webhook URL?
Make sure that your webhook server supports the required types of HTTP requests (POST, GET).
Why are webhooks not sent to my mobile application?
Webhooks are sent to only a single URL address specified in your project settings. Being server-to-server, webhooks cannot be sent to several URL addresses. If you would like to receive notifications in your game, website, or mobile application, set up sending webhooks on your server to pass data between Xsolla and your game.
Why is the Authorization header missing from the webhook request?
To fix this error, you need to edit the .htaccess or httpd.conf Apache files. Refer to the SDK documentation for more information.
SDKs
What Xsolla SDKs are available?
Xsolla supports the following SDK:
Where can I find detailed information about each SDK?
Go to SDK documentation and choose the corresponding section.
Is there SDK for Node.JS/C#/Ruby/Java/ASP, etc.?
Currently there are SDK for PHP and Android. You can build your own SDK using any language/platform, as long as it has HTTPS request functionality.
Automatic notifications about critical changes in Publisher Account settings
Xsolla notifies you of changes to your project settings that could impact payment processing or the operation of your systems. Email notifications are sent to users with the Owner role specified in Publisher Account in the Company settings > Users section. Notifications are sent with a delay of up to 1 minute.
| Publisher Account section | Notification events |
|---|---|
| Company settings |
|
| Project settings |
|
| Store | Changes in the settings of game keys, virtual currency, and virtual items:
|
User activity log
The user activity log displays the main actions taken by your company users related to the operation of key Xsolla services. Log captures HTTP requests to the API that are sent directly or triggered via the Publisher Account UI.
You can view the user activity log in Publisher Account in the Company settings > Activity section.
This section is available to Publisher Account users who meet the following criteria:
- Have the Owner role.
- If access is restricted by project, the user must have access to all projects.
Key features:
- Filter data by time period and the email address of the user who initiated the API request.
- Export the user activity log as a CSV file based on the applied filter.
- The log includes data from the past 2 years. To request data older than 2 years, contact your Customer Success Manager or email to csm@xsolla.com.
- Data can only be exported for a period of up to 1 year. To export data for a longer time range, divide it into smaller segments of less than one year and export each segment separately.
Found a typo or other text error? Select the text and press Ctrl+Enter.
