Launching integration in JavaScript

This guide will help you set up the simplest test integration in JavaScript from scratch for store requests to the Market. You can request a list of stores and get a response.

Download the OpenAPI specification

Generate a client

1. Open the folder yandex-market-partner-api, which appeared in the previous step.
2. Run the command prompt in it.
3. Write a command:

npx @openapitools/openapi-generator-cli generate -i <path_to_openapi.yaml> -g javascript -o <output_path>

As a output path specify the folder where your project will be located.

If openapitools until it is installed, agree to the installation. In the folder output path the client's files will appear.

Example

Let's say you downloaded an archive and unpacked it. The specification is in the folder <project_directory>/yandex-market-partner-api.

Do you want to place the project in a folder <project_directory>/market-integration.

1. Open the folder <project_directory>/yandex-market-partner-api.

2. Run the command prompt in it.

3. In the console that opens, write:

npx @openapitools/openapi-generator-cli generate -i openapi/openapi.yaml -g javascript -o ../market-integration

4. If you are prompted to install the generator, enter Y and click Enter.

Create a project

1. Open the folder where the client's files are located. In the example above, this is <project_directory>/market-integration.

2. Run the command prompt in it.

3. Write a command:

   npm install
   npm run build
   

Prepare the data for access

Get an authorization token by Instructions.

Make a request

To perform GET campaigns:

1. Open the created project in the IDE.

2. Create in the root of the project (folder <project_directory>/market-integration) file index.js.

3. Create an instance CampaignsApi and refer to the method getCampaigns. To do this, write to index.js here is the code:

   const { CampaignsApi } = require('./dist');
   
   const campaignsApi = new CampaignsApi();
   campaignsApi.apiClient.authentications['ApiKey'].apiKey = '<token>';
   
   campaignsApi.getCampaigns(undefined, function (error, data) {
       console.log(JSON.stringify(data, null, 4));
   });
   

   As a <token> use the token you received in the previous step.

4. Write to the console node index.js.

The console will display the result of the query: the names of all stores, placement models, IDs, and more:

{
    "campaigns": [
        {
            "domain": "Shop 1",
            "id": 12345678,
            "clientId": 87654321,
            "business": {
                "id": 123456,
                "name": "My shop"
            },
            "placementType": "FBS"
        },
        {
            "domain": "Shop 2",
            "id": 23456789,
            "clientId": 98765432,
            "business": {
                "id": 123456,
                "name": "My shop"
            },
            "placementType": "DBS"
        },
        {
            "domain": "GoodShop",
            "id": 34567891,
            "clientId": 19876543,
            "business": {
                "id": 123456,
                "name": "My shop"
            },
            "placementType": "FBY"
        },
    ],
    "pager": {
        "total": 3,
        "from": 1,
        "to": 3,
        "currentPage": 1,
        "pagesCount": 1,
        "pageSize": 3
    }
}