Settings

Integration parameters

To set up integration you will need:

Note

Parameter values differ between the test and production environments. To view the settings for each environment, use the Test data option in the top-right corner.

To learn more about setting up the test environment, see Testing.

How to find the Merchant ID

To find the unique Merchant ID of a store, select the store in the selector and go to Settings → Merchant ID.

Issuing an API key

When testing the service, the Merchant API key value is identical to the Merchant ID value.

To work in the production environment, you'll need to generate your own API key in your Yandex Split personal account:

  1. Make sure the correct store is selected in the selector, then go to SettingsIssue Merchant API key.

  2. You'll see the API key in the window that opens. Copy and save it.

    Tip

    Once the key is generated, we recommend saving it right away — the full value is only shown once, at the time of creation. You can't view the generated key again.

  3. If you previously used a different API key for testing or production, replace the current API key with the new one in your store's backend code.

If you lose or forget the API key, you'll need to issue a new one. To issue a key, click Merchant API keyIssue another key in the settings. No more than three API keys can be active for a store at the same time.

Setting a Callback URL

  1. Go to SettingsAdd Callback URL.
  2. In the window that appears, enter the publicly accessible HTTPS URL of the store's backend you're setting up the integration for, then click Save.

Enter the Callback URL without /v1/webhook — this path will be added automatically, for example:

Callback URL

Where the request will be sent

https://example.merchant.ru

https://example.merchant.ru/v1/webhook

https://example.merchant.ru/v1/webhook

https://example.merchant.ru/v1/webhook/v1/webhook

The URL may differ between the test and production environments, for example:

Environment type

Callback URL

Production

https://example.merchant.ru

Test

https://sandbox.example.merchant.ru

For more information about notifications, see the Merchant API section of the developer reference.