BestChange v2 / DONE

BestChange v2 parser setup instructions

Parser Installation

Using the parameters below, install the parser via the ‘Install plugin’ functionality according to the instructions: Install plugin / DONE.

Install Plugin Parameters

Plugin type: Parser-rate module

Plugin URL: @boxexchanger-plugins/parser-bestchange-v2

Directory path: bestchange-v2

Auth: (Deploy token): leave blank

Package tag: latest

Setting up the parser

1. To start the parser, follow the instructions Rate parser / DONE.

To apply changes in the field, you must agree to restart the server processes.

1. In the field ‘api_key’ specify the API key (see clarification below) to get exchange rates -> click ‘Apply changes (API_KEY).

You can generate an API key to receive exchange rates in BestChange account at the following link: https://www.bestchange.ru/partner/profile.html. On the page ‘Profile’ - in the section ‘API for receiving exchange rates’, agree to the terms of use of BestChange -> click "Get" -> copy the API key.

1. It is recommended to leave the ‘batch’ field unchanged. The value in this field is responsible for the number of rates that will be processed in one API request. Maximum value: 500.

2. In the ‘places’ field specify the places for which it is necessary to receive rates. For example, if you want to get rates for 1,2 and 4 places from the BestChange list by pair - enter 1,2,4 -> click ‘Apply changes (PLACES)’.

3. In the ‘routes’ field, enter the pairs for which you want to get rates. Learn more about the format and specifics of entering pairs:

Note, you must use the signatures provided on the BestChange page as XML for currencies and cities: https://www.bestchange.ru/wiki/rates.html

• Special recommendations when specifying pairs: а) Cashless currencies: XML1_XML2. For example, to get the rates for the pair USDT TRC20 -> Monobank UAH you should enter USDTTRC20_MONOBUAH б) Cash currencies: XML1_XML2-CITY. For example, to get the rates for the pair Cash USD KIEV -> USDT TRC20 you should enter: CASHUSD_USDTTRC20-KIEV

• Pairs should be separated by comma (,). Example:USDTTRC20_MONOBUAH,CASHUSD_USDTTRC20-KIEV,BTC_USDTTRC20

-> click ‘Apply Changes (ROUTES)’.

1. In the ‘cityKey’ field, specify the format for displaying the name of the city in the pair: а) name value (by default). With this parameter, the name of the city in the admin panel will be displayed as the name of the city in English, which is specified on the BestChange page. For example, if you enter CASHUSD_USDTTRC20-WRCL, in the ‘routes’ field, the pair will be displayed in the admin panel as TOP_1 - CASHUSD - WROCLAW -> USDTTRC20. б) codevalue. With this parameter, the city name in the admin panel will be displayed as the city signature that is specified on the BestChange page. For example, if you enter CASHUSD_USDTTRC20-WRCL, in the ‘routes’ field, the pair will be displayed in the admin panel as TOP_1 - CASHUSD - WRCL -> USDTTRC20. -> click ‘Apply Changes (CITYKEY)’.

If the format of the city display in the ‘cityKey’ field is changed, provided that the parser is active and there are pairs in it, the existing rates with the previous city name will no longer be updated, but new rates will be added that are specified in the ‘routes’ field with the updated city name.

1. In the ‘sourceRate’ field specify the source of the rate:

a) The value of bestchange.ru. With this parameter the rates will be parsed from the Russian version of BestChange.

b) The value of bestchange .com. With this parameter the rates will be parsed from the English version of BestChange.

1. In the ‘Interval’ field, specify the frequency of updating rates in milliseconds. Recommended value: 15000 -> click ‘Apply changes (INTERVAL)’.

2. In the ‘ignoreChangerIds’ field you can specify BestChange id of exchange services whose rates will be ignored during parsing.

Make sure to add in the field "ignoreChangerIds" BestChange Id of your exchange service. This step is necessary for the parser to ignore the rate of your exchanger when receiving rates and take into account only the rates of your competitors.

1. Parser is set up.

Before using the parser, also read theRate parser / DONE section to understand the order in which rates are updated.

Rates validation

If BestChange has no rates for the pair specified in the ‘routes’ field -> the system will set the rate 0 for this pair.

• On the client side, the direction with rate 0 will be displayed, but will become unavailable for creating a request.

• In the admin panel on the ‘Setting directions ’ page - a warning sign will be displayed in the field with the direction that has the rate 0. When pointing at this sign, the comment "Parser rate invalid rate can't be 0" will be displayed.

• In case the rate for a pair appears on BestChange, the rate will be automatically updated in the parser and the direction will be available again for creating a request on the client part. In the admin panel, in turn, the rate will also be updated and the warning sign will disappear.