Eqvola Cabinet Api Documentation

Modules:

Методы модуля account

Метод account/before_register post

Предварительная регистрация пользователя.

Если смс или смс регистрация не активированы, то будет возвращена ошибка.

Если емеил или телефон регистрируемого пользователя уже заняты, то будет возвращена ошибка.

Параметры:
  • language - Язык регистрируемого пользователя.
  • email - Email регистрируемого пользователя.
  • phone_code - Код страны телефона регистрируемого пользователя.
  • phone_number - Номер телефона регистрируемого пользователя.

Метод account/check_before_register post

Проверка кода предварительной регистрации.

Параметры:
  • register_id - Идентификатор кода регистрации.
  • register_code - Код присланный в смс.

Метод account/resend_before_register post

Отправка нового кода регистрации.

Если с последней отправки не прошло 60 секунд, то будет возвращена ошибка.

Параметры:
  • register_id - Идентификатор кода регистрации.

Метод account/lock post

Метод блокировки токена.

Параметры:
  • token - Токен, который блокируется.

Метод account/unlock post

Метод разблокировки токена.

Параметры:
  • token - Токен, который разблокирывается.
  • password - Пароль владельца токена.

Метод account/login post

Метод авторизации пользователя.

Передача кода двухфакторной верификации необязательна, если оная не включена у пользователя.

Если у пользователя включена двухфакторная верификация, а код не был передан, то будет сгенерирована соответствующая ошибка.

Параметры:
  • email - Email пользователя.
  • password - Пароль пользователя.
  • code - Код двухфакторной верификации.

Метод account/user/change_rights post

Метод изменения прав пользователей.

Для использования этого метода нужно обладать правами CAN_RIGHTS.

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя, чьи права изменяются.
  • rights - Новые права пользователя.

Метод account/verification/enable post

Включение двухфакторной верификации.

Метод возващает информацию для подключения двухфакторной верификации - код и qr-код.

Параметры:
  • token - Токен авторизации пользователя.

Метод account/verification/disable post

Отключение двухфакторной верификации.

Параметры:
  • token - Токен авторизации пользователя.
  • code - Код из приложения двухфакторной верификации.

Метод account/verification/accept post

Подверждение включения двухфакторной верификации.

Параметры:
  • token - Токен авторизации пользователя.
  • code - Код из приложения двухфакторной верификации.

Метод account/verification/change post

Изменение резервных кодов двухфакторной верификации.

Резервные коды можно обновлять раз в 24 часа.

Параметры:
  • token - Токен авторизации пользователя.

Методы модуля partner

Метод partner/link/show post

Регистрация показа ссылки партнера.

В ссылке обязательно должен быть сегмент partner_code. Если сегмента не будет, то будет возвращена ошибка.

Если ссылки не существует, то будет создана новая ссылка.

Параметры:
  • link - ссылка, показ которой нужно зарегистрировать.

Методы модуля pamm

Метод pamm/rollover/ post

Вызов ролловера.

Вызов ролловера производится раз в день. Если ролловер вызывается чаще, то будет возвращена ошибка.

Метод pamm/master/get post

Получение информации о мастерах.

Параметры:
  • token - Токен пользователя.
  • where - Запрос, по которому будет выведена информация.

Метод pamm/master/info post

Получение подробной информации о мастере.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера.

Метод pamm/master/set post

Метод изменения информации о мастерами.

Данные передаются в формате json типом ключ - значени. Переменная conditions - массив объектов.

Если пользователь является владельцем мастера и не имеет прав CAN_PAMM, то он может изменить только avatar и description мастера.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера.
  • data - Данные для изменения.

Метод pamm/master/account post

Получение свободных счетов, на которые можно зарегистрировать мастера.

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя.

Метод pamm/master/register post

Регистрация нового мастера.

В правилах беконечность указывается как -1.

Для создания мастера другому пользователю нужно обладать правами CAN_PAMM.

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя на которого регистрируется мастер.
  • account - Счет на который регистрируется памм мастер.
  • avatar - Аватар мастера.
  • description - Описание мастера.
  • nickname - Никнейм мастера.
  • conditions - Условия мастера.
  • statement_account - Аккаунт, на котором торговал мастер для проверки администратором.
  • statement_account_ip - Ip адресс, где можно посмотреть информацию о аккаунте. Если он находится не в кабинете.
  • statement_account_password - Пароль от аккаунта, который находится не в кабинете.
  • statement - Файл-приложение для администратора, где описаны данные о торговле пользователя.
  • comment - Комментарий для администратора.

Метод pamm/master/accept post

Подтверждение мастера.

Для использования этого метода нужно обладать правами CAN_PAMM.

Если мастер отклонен, то его можно подтвердить.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера.

Метод pamm/master/deny post

Отклонение мастера.

Для использования этого метода нужно обладать правами CAN_PAMM.

Если мастер подтвержден, то его можно отклонить.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера.

Метод pamm/master/avatar get

Получение изображения мастера.

Параметры:
  • master_id - Идентификатор мастера.

Метод pamm/master/statement get

Получение стейтмента мастера.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера.

Метод pamm/master/invest get

Получение инвестиций мастеров.

При использовании этого метода можно получить инвестиции в мастеров текущего пользователя.

При пропуске параметра status или передаче в него -1 будут возвращены инвестиции со всеми статусами.

Параметры:
  • token - Токен пользователя.
  • status - Требуемый статус в котором будут возвращены инвестиции.

Метод pamm/master/withdrawal get

Получение выводов мастеров.

При использовании этого метода можно получить выводы мастеров текущего пользователя.

При пропуске параметра status или передаче в него -1 будут возвращены выводы со всеми статусами.

Параметры:
  • token - Токен пользователя.
  • status - Требуемый статус в котором будут возвращены выводы.

Метод pamm/invest/get post

Получение инвестиций.

Параметры:
  • token - Токен пользователя.
  • where - Запрос, по которому будет выведена информация.

Метод pamm/invest/do post

Инвестиция в мастера.

Нельзя инвестировать в мастера со счета этого же мастера.

Параметры:
  • token - Токен пользователя.
  • master_id - Идентификатор мастера в которого производится инвестиция.
  • account - Счет с которого производится инвестиция.
  • amount - Количество инвестируемых средств.

Метод pamm/invest/accept post

Подтверждение инвестиции в мастера.

Если средств на балансе инвестора будет недостаточно - инвестиция не зачислиться.

Во время инвестиции с баланса инвестора резервируется сумма инвестиции.

Подтверждать инвестиции может только мастер, в которого текущая инвестиция была совершена.

Параметры:
  • token - Токен пользователя.
  • invest_id - Идентификатор инвестиции, которая подтверждается.

Метод pamm/invest/deny post

Отмена инвестиции в мастера.

Отменять инвестиции может только мастер, в которого текущая инвестиция была совершена.

Параметры:
  • token - Токен пользователя.
  • invest_id - Идентификатор инвестиции, которая отменяется.

Метод pamm/withdrawal/get post

Получение выводов инвестиций.

Параметры:
  • token - Токен пользователя.
  • where - Запрос, по которому будет выведена информация.

Метод pamm/withdrawal/do post

Вывод инвестиции пользователя.

Параметры:
  • token - Токен пользователя.
  • invest_id - Идентификатор инвестиции, которую выводят.

Метод pamm/withdrawal/accept post

Подтверждение вывода инвестиции.

Если средств на балансе инвестора будет недостаточно - вывод инвестиции не подтвердится.

Подтверждать вывод инвестиций может только мастер, в которого текущая инвестиция была совершена.

Параметры:
  • token - Токен пользователя.
  • withdrawal_id - Идентификатор вывода инвестиции, который подтверждается.

Метод pamm/withdrawal/deny post

Отмена вывода инвестиции.

Отменять вывод инвестиций может только мастер, в которого текущая инвестиция была совершена.

Параметры:
  • token - Токен пользователя.
  • withdrawal_id - Идентификатор вывода инвестиции, который отменяется.

Методы модуля wallet

Метод wallet/get post

Получение кошельков пользователей.

Для получения пользователей кроме себя нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • where - Данные для выборки кошельков.

Метод wallet/all post

Получение информации о всех пользовтелях с их кошельками.

Для использования этого метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.

Метод wallet/check post

Проверка существования кошелька у пользователя.

Для использования метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор проверяемого пользователя.

Метод wallet/create post

Создание локального кошелька пользователю у которого его нет.

Для использования метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя, которому создается кошелек.

Метод wallet/number/type post

Получение типов номеров.

Параметры:
  • token - Токен пользователя.

Метод wallet/number/type_image get

Получение изображения типа номера.

Параметры:
  • number_type_id - Идентификатор типа номера.

Метод wallet/number/type_create post

Создание типа номера.

Для использования метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • title - Название типа номера.
  • image - Изображение типа номера.

Метод wallet/number/type_update post

Изменение типа номера.

Для использования метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • number_type_id - Идентификатор типа номера.
  • title - Название типа номера.
  • image - Изображение типа номера.

Метод wallet/number/type_remove post

Удаление типа номера.

Для использования метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • number_type_id - Идентификатор типа номера.

Метод wallet/number/get post

Получение номеров кошельков пользователей.

Для получения номеров кошельков всех пользователей нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • where - Данные для выборки номеров кошельков.

Метод wallet/number/count post

Получение количества номеров кошельков пользователей.

Для получения количества номеров кошельков всех пользователей нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • where - Данные для выборки номеров кошельков.

Метод wallet/number/set post

Изменение номера кошелька пользователя.

Параметры:
  • token - Токен пользователя.
  • number_id - Идентификатор номера кошелька пользователя.
  • number - Номер кошелька пользователя.

Метод wallet/number/accept post

Подтверждение номера кошелька пользователя.

Для использования этого метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • number_id - Идентификатор номера кошелька пользователя.

Метод wallet/number/deny post

Отмена номера кошелька пользователя.

Для использования этого метода нужно обладать правами CAN_WALLET

Параметры:
  • token - Токен пользователя.
  • number_id - Идентификатор номера кошелька пользователя.

Методы модуля join

Метод join/is_active post

Проверка активности модуля джоин.

Метод join/check post

Метод проверки текущей сессии на то, является ли она джоин сессией.

Параметры:
  • token - Токен пользователя.

Метод join/register post

Регистрация джоин аккаунта.

Для авторизации в этому методе следует использовать один из параметров - token или register_code.

Параметр data включает в себя обязательные параметры: name, country_id, phone, birth_date, street, city, state, zip, identity_document, second_document.

Параметры:
  • token - Токен пользователя.
  • register_code - Код пострегистрации.
  • email - Email регистрируемого джоин аккаунта.
  • data - Данные регистрируемого джоин аккаунта.

Метод join/get post

Метод получения джоин аккаунтов.

Параметры:
  • token - Токен пользователя.
  • where - Данные для выборки джоин аккаунтов.

Метод join/count post

Метод получения количества джоин аккаунтов.

Параметры:
  • token - Токен пользователя.
  • where - Данные для выборки джоин аккаунтов.

Метод join/document get

Метод получения документа джоин аккаунта.

В данный момент в праметр document можно передать identity или second.

Параметры:
  • token - Токен пользователя.
  • join_id - Идентификатор джоин аккаунта чей документ нужно получите.
  • document - Название документа, который нужно получить.

Метод join/approve post

Метод подтверждения джоин аккаунта.

Для использования этого метода нжуно обладать правами CAN_JOIN.

Параметры:
  • token - Токен пользователя.
  • join_id - Идентификатор джоин аккаунта.

Метод join/deny post

Метод отклонения джоин аккаунта.

Для использования этого метода нжуно обладать правами CAN_JOIN.

Параметры:
  • token - Токен пользователя.
  • join_id - Идентификатор джоин аккаунта.
  • comment - Комментарий/причина отклонения.

Методы модуля crm

Метод crm/pages post

Получение списка страниц.

Параметры:
  • token - Токен пользователя.

Метод crm/department/get post

Получение департаментов.

Для получения списка департаментов нужно обладать правами CAN_CRM_ADMIN.

Параметры:
  • token - Токен пользователя.
  • where - Запрос, по которому будет выведена информация.

Метод crm/department/create post

Создание департаментов.

Для создания департамента нужно обладать правами CAN_CRM_ADMIN.

Параметр pages передается в числовом еквиваленте страниц.

Параметр groups принимает идентификаторы групп через запятую.

Параметр locations принимает идентификаторы локаций через запятую.

Параметры:
  • token - Токен пользователя.
  • title - Название департамента.
  • pages - Страницы доступные департаменту.
  • groups - Группы, которые привязаны к департаменту.
  • locations - Локации привязанные к департменту.

Метод crm/department/update post

Изменение департаментов.

Для изменения департамента нужно обладать правами CAN_CRM_ADMIN.

Параметр pages передается в числовом еквиваленте страниц.

Параметр groups принимает идентификаторы групп через запятую.

Параметр locations принимает идентификаторы локаций через запятую.

Параметры:
  • token - Токен пользователя.
  • department_id - Идентификатор департамента.
  • data - Данны для изменения департамента.

Метод crm/department/add_client post

Добавление клиента в департамент.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3.

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя.
  • department_id - Идентификатор департамента.

Метод crm/manager/create post

Метод создания менеджера.

Для создания менеджера нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3.

При создании менеджера с таким же типом как и создатель, будет выдана ошибка.

При создании менеджера с типом или департаментами неподходящими создателю, будет выдана ошибка.

Параметры:
  • token - Токен пользователя.
  • user_id - Идентификатор пользователя, который способен стать менеджером.
  • type - Тип менеджера.
  • departments - Идентификаторы департамента.

Метод crm/manager/update post

Метод изменения менеджера.

Для изменения менеджера нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2.

При изменени типа менеджера на выше или такой же как у менеджера-изменяющего будет выдана ошибка.

При несоответствии переданных департаментов с департаментами менеджера-изменяющего будет выдана ошибка.

Параметры:
  • token - Токен пользователя.
  • manager_id - Идентификатор изменяемого менеджера.
  • type - Тип менеджера.
  • departments - Идентификаторы департамента.

Метод crm/manager/free post

Метод получения свободных пользователей, которые готовы стать менеджерами.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3.

Параметры:
  • token - Токен пользователя.

Метод crm/client/get post

Метод получения привязанных к менеджеру клиентов.

Параметры:
  • token - Токен пользователя.

Метод crm/client/id post

Метод получения клиента по его идентификатору.

Параметры:
  • token - Токен пользователя.
  • client_id - Идентификатор получаемого клиента.

Метод crm/client/bind post

Метод привязки клиента к менеджеру.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • client_id - Идентификатор привязываемого клиента.
  • manager_id - Идентификатор менеджера к которому привязывается клиент.

Метод crm/client/unbind post

Метод отвязки клиента.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • client_id - Идентификатор отвязываемого клиента.

Метод crm/client/manager_free post

Метод получения не привязанных к менеджерам клиентов.

Параметры:
  • token - Токен пользователя.

Метод crm/client/free post

Метод получения не привязанных к департаментам клиентов.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3.

Параметры:
  • token - Токен пользователя.

Метод crm/task/self post

Метод получения личных задач

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4, CRM_SUPERVISER - 5.

Параметры:
  • token - Токен пользователя.

Метод crm/task/id post

Метод получения задачи по ее идентифкатору

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4, CRM_SUPERVISER - 5.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.

Метод crm/task/create post

Метод создания задач

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Создавать задачи может менеджер себе и так же подчиненным менеджерам.

Параметры:
  • token - Токен пользователя.
  • title - Название задачи.
  • description - Описание задачи.
  • manager_id - Кому задача ставится.
  • department_id - Департамент куда ставится задача.
  • clients - Клиенты, которые привязаны к задаче.
  • priority - Приоритет задачи.
  • deadline_date - Дата окончания выполнения задачи.

Метод crm/task/open post

Метод начала работы задачи

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.

Метод crm/task/close post

Метод конца работы задачи

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.

Метод crm/message/get post

Метод получения сообщений задачи.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4, CRM_SUPERVISER - 5.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.
  • last_message_id - Идентификатор последнего полученного сообщения для получения новых.

Метод crm/message/send post

Метод отправки сообщения в задачу.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.
  • message - Сообщение.

Метод crm/attachment/get get

Метод получения приложения из задачи.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_attachment_id - Идентификатор приложения.

Метод crm/attachment/type post

Метод получения типа приложения из задачи.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_attachment_id - Идентификатор приложения.

Метод crm/attachment/send post

Метод отправки приложения в задачу.

Для использования этого метода нужно обладать менеджером такого типа как CRM_SUPER_ADMIN - 1, CRM_ADMIN - 2, CRM_TOP_MANAGER - 3, CRM_MANAGER - 4.

Параметры:
  • token - Токен пользователя.
  • task_id - Идентификатор задачи.
  • attachment - Отправляемое приложение в формате base_64.

Методы модуля local_deposit

Метод local_deposit/depositor/get post

Метод получения депозиторов локального депозита.

Если пользователь не обладает правами CAN_LOCAL_DEPOSIT, то ему будут возвращены только подтвержденные депозиторы.

Параметры:
  • token - Токен пользователя.
  • where - Данные для получения депозиторов.

Метод local_deposit/depositor/create post

Метод для создания локального депозитора.

Параметры:
  • token - Токен пользователя.
  • nickname - Имя локального депозитора.
  • email - Email локального депозитора.
  • phone - Телефон локального депозитора.
  • country - Страна локального депозитора.
  • account - Счет локального депозитора.