# Heleket control available

## Описание модуля

Модуль "**Heleket control available**" позволяет мониторить статус депозита/вывода валют на Heleket и в зависимости от их статуса отключать/включать направления, в которых Heleket используется в качестве модуля приема/выплаты.  \
\
**Пример 1**: В случае если на Heleket будет временно закрыт депозит BTC, то модуль автоматически отключит все направления BTC->Сurrency, то есть в которых BTC является валютой приема. \
Далее, если депозит BTC станет снова доступен на Heleket, то модуль автоматически включит направления BTC->Сurrency. \
\
**Пример 2**: В случае если на Heleket будет временно закрыт вывод BTC, то модуль автоматически отключит все направления Currency->BTC, то есть в которых BTC является валютой вывода. \
Далее, если вывод BTC станет снова доступен на Heleket, то модуль автоматически включит направления Currency->BTC.

## Установка модуля

Используя параметры ниже, установите модуль через функционал "**Install plugin**" по инструкции [install-plugin](https://manual.boxexchanger.net/dopolnitelnye-sistemy/install-plugin "mention").

<details>

<summary>Параметры для Install Plugin</summary>

**Plugin type**: <mark style="color:orange;">**`External module`**</mark>

**Plugin URL**: <mark style="color:orange;">**`@boxexchanger-plugins/module-heleket-control-route`**</mark>

**Directory path**: <mark style="color:orange;">**`heleket-control-route`**</mark>

**Auth: (Deploy token)**: оставляем пустым

**Package tag**: <mark style="color:orange;">**`latest`**</mark>

</details>

## Конфигурация

1. В админ панели скрипта зайдите на страницу "**Доп модули**" -> в разделе "**MODULE SYSTEM**" [**нажмите**](#user-content-fn-1)[^1] на значок настроек в блоке с модулем "**Heleket control available**".
2. Для того чтобы включить модуль, на странице настроек "**Heleket control available**" укажите значение "**1**" в поле "**Enable module**" -> нажмите "**Save**".&#x20;
3. Скопируйте значения "**Merchant Id**", "**Payment API Key**" и "**Payout API Key**", которые вы сохраняли при настройке модуля выплаты Heleket либо следуйте инструкции [#nastroika-modulya](https://manual.boxexchanger.net/obmen/merchant-i-api/heleket/vyplaty-heleket#nastroika-modulya "mention")(шаги 1-8).
4. В поле "**Merchant Id**" укажите значение "**Merchant Id**" из шага 3 -> нажмите "**Save**" -> в поле "**Payment API Key**" укажите значение "**Payment API Key**" из шага 3 -> нажмите "**Save**" -> в поле "**Payout API Key**"  укажите значение "**Payout API Key**" из шага 3 -> нажмите "**Save**".
5. Для проверки статуса депозита валют на прием, в поле "**Merchant IDs**" укажите Directory path модуля(-ей) приема Heleket. Directory path мерчанта возможно найти на странице настроек модуля приема в адресной строке. Пример на [**скриншоте**](#user-content-fn-2)[^2]. \
   **Пример**: <mark style="color:green;">**`heleket,heleket-2`**</mark> -> Нажмите "**Save**".

{% hint style="info" %}
Модуль будет проверять статус депозита валют на Heleket и в зависимости от статуса включать/отключать направления, в которых для валюты приема установлен мерчант Heleket (Directory path которого вы указали в поле "**Merchant IDs**").
{% endhint %}

6. Для проверки статуса вывода валют на выплату, в поле "**Payout IDs**" укажите Directory path модуля(-ей) выплаты Heleket. Directory path выплаты возможно найти на странице настроек модуля выплаты в адресной строке. Пример на [**скриншоте**](#user-content-fn-3)[^3]. \
   **Пример**: <mark style="color:green;">**`heleket,heleket-2`**</mark> -> Нажмите "**Save**".

{% hint style="info" %}
Модуль будет проверять статус вывода валют на Heleket и в зависимости от статуса включать/отключать направления, в которых для валюты вывода установлена выплата через Heleket (Directory path которого вы указали в поле "**Payout IDs**").
{% endhint %}

7. Через 2 минуты после сохранения параметров выше, модуль начнет отключать направления, которые подходят под критерии. \
   Каждые 2 минуты модуль обновляет информацию о статусе депозита/вывода валют и может отключать/включать направления, которые подходят под критерии.&#x20;

[^1]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2F9nQbcFQWhKUTNHrhlkad%2Fimage.png?alt=media\&token=c446036e-92e9-4701-abd8-aea5b9c8f073)

[^2]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FQM3HIL2GMqVAxlWC4mpi%2Fimage.png?alt=media\&token=546a06b8-35c4-4b57-82fa-c9bfd4c8ebc2)

[^3]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FrZPzVo78U4sSESLNzwYs%2Fimage.png?alt=media\&token=ca37b5c7-6c1f-4fe2-ad5d-b8fed931033f)
