API Keys
Overview
Extend the capabilities provided by the Merchant Portal using our APIs:
- Products API
Сreate and manage products: configure prices, subscriptions, additional products, etc - Dynamic Product Checkout API
Create one-time checkout links with additional parameters allowing you to identify product characteristics and pre-fill customer data.
See also: Compare management options of Product API, Dynamic Product Checkout API and Merchant Portal - Promotions API
Provide customers with product discounts. Use instant discounts or use discounts activated by promotion codes (coupons) - Orders API
Get order data using IDs and other characteristics. Create refund requests - Subscriptions API
Get subscription data, change or cancel subscriptions - Authentication API
Receive a token that is later used to authorize the user when working with other API
When using any of our APIs, a token is required to authorize you in the system. You can get tokens via the Authentication API.
This documentation explains how to:
- Create API accounts for test and production environments
- Change your password allowing you to get a token for authorization when working with one of our APIs
Create Your API Account
To get started with an API, you have to create an account. You will use the data of this account (username and password) later when trying to get a token via the Authentication API.
After you have created your account, you will also be provided with access to all the APIs mentioned above.
To create an account:
- Open the Merchant Portal and log in to it
- Check what mode you are using
- If using Test Mode, your account will be assigned to work with an API in the test environment
- If using Sales Mode, your account will be assigned to work with an API in the production environment
- Go to Developers / API Keys
- Click Create Password
- The system will create your account as well as the connection settings required for access to all the APIs mentioned above
- You will see a pop-up window containing the information on the created connection as well as the data (API login and password) necessary for you to work with the Authentication API
- IMPORTANT! Make sure you save this data on your end. After closing the pop-up window, you will not be able to view your password again
You can create only one account per environment (test/production).
How to Use Your API Account
After you have created your account, you get the data required for authorization (API login and password). Use this data when sending a request for getting an authorization token to the Authentication API:
The data of your account created via the portal |
The data required for a request to be sent to get an authorization token |
API login |
|
Password |
Use the authorization token when working with any of our APIs. No additional configuration on our end is required for you to start using the APIs. See the additional instructions explaining how to work with each of the APIs.
View Your API Account
After you have created your account, you can view all the information about it in the section called API Keys.
- Open the Merchant Portal and log in to it
- Go to Developers / API Keys
You can see your account intended for either the test environment or the production environment. It depends on the mode (Test Mode/ Sales Mode) you are using to work with the portal.
The following information is displayed for your account:
- API login (used as username when working with the Authentication API)
- 4 last characters of your password
It is impossible to view the password in full. If you lose your password, you will have to change it. - Date of last password update
Change Your API Account Password
You can change the password for your account after it has been created. The previous password will no longer be valid.
You have to:
- Open the Merchant Portal and log in to it
- Check what mode you are using
- If using Test Mode, your account is assigned to work with an API in the test environment
- If using Sales Mode, your account is assigned to work with an API in the production environment
- Go to Developers / API keys
- Click the Roll Password button in the block of the previously created account
- The system will generate a new password for your account and display it on the screen. Note that your previous password will no longer be valid
- IMPORTANT! Make sure you save your new password on your end. After closing the pop-up window containing the password, you will not be able to view it again