Работа с API

REST API - Дает возможность работать с обменным пунктом через API

iEXExchanger API — позволяет автоматизировать получение информации о курсах, партнерской программы, заявок, которые представлены обменнике.

Чтобы использовать iEXExchanger API, вам необходимо получить API key

Получение API Ключа

Для получения API Key, Вам необходимо выполните следующие действия:

1. Авторизуйтесь или Зарегистрируйтесь на сайте обменника.

2. Перейдите в личный кабинет и в разделе "Настройки" откройте вкладку "REST API"

3. Далее, скопируйте ключ который там представлен.

По умолчанию API доступен не всем клиентам: Чтобы включить API, откройте панель управления обменником, зайдите в "Пользователи — Список пользователей", выберите пользователя для которого хотите включить API и нажмите на имя пользователя для редактирования настроек.

Найдите Разрешить доступ к REST API и включите данную функцию

Разрешение для API

Для того чтобы получать доступы к определенным разделам API, у ключа должны разрешения.

Разрешения выдаются в разделе API — Список API

Использование API

Точка входаhttps://your_domain/api/v2/

your_domain - замените на домен обменника (Например: test.com)

Отправляемые данные должны быть в формате JSON с кодировкой UTF-8.

Для успешных запросов API все запросы должны содержать несколько обязательных заголовков (headers):

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <YOUR_API_KEY>

Пример запроса

Laravel Http

use Illuminate\Support\Facades\Http;

$api_key = 'YOUR_API_KEY';
$base_url = 'https://your_domain/api/v2'
$response = Http::baseUrl($base_url)->withToken($api_key)->asJson();

Методы работы с API

Внизу перечислены все методы для работы с API

Тест соединения

GET /state

Метод для тестирования работы API

Пример запроса

Laravel Http

use Illuminate\Support\Facades\Http;

$api_key = 'YOUR_API_KEY';
$base_url = 'https://your_domain/api/v2'
$response = Http::baseUrl($base_url)->withToken($api_key)->asJson()
                ->get('/state')->json();

Ответ

200

{
  "result": true
}

Список принимаемых валют

GET /currencies-list

Получение списка всех активных валют

Схема ответа

Параметр	Тип поля	Описание
data	dict	Информация о валютах
id	int	ID Валюты
type	string	Тип массива
attributes	dict	Параметры валюты
name	string	Название валюты
currency_type	string	Фильтры валюты
payment_name	string	Название ПС
iso_code	string	Код валюты
letter_cod	string	Общепринятый код валюты
decimal	int	Знаки, после запятой

Пример запроса

Laravel Http

use Illuminate\Support\Facades\Http;

$api_key = 'YOUR_API_KEY';
$base_url = 'https://your_domain/api/v2'
$response = Http::baseUrl($base_url)->withToken($api_key)->asJson()
                ->get('/cashe/currencies-list')->json();

Пример ответа

200

{
    "data":{
        "1":{
            "id":1,
            "type":"currency",
            "attributes":{
                "name":"СберОнлайн",
                "currency_type":"РУБ",
                "payment_name":"СберОнлайн",
                "iso_code":"RUB",
                "letter_cod":"SBERRUB",
                "decimal":2
            }
        }
        ///....
    }
}

Список операций для валют

GET /operations/{id_валюты}/

Получаем список операций для валюты

Схема ответа

Параметр	Тип поля	Описание
data	dict	Информация о валютах для получаю
id	int	ID Направления обмена
type	string	Тип массива
attributes	dict	Параметры получаемой валюты
buy_currency	dict	Информация о валюте для получаю
id	int	ID Получаемой валюты
name	string	Название валюты
currency_type	string	Фильтр валюты
payment_name	string	Название П.С
iso_code	string	Код валюты
letter_cod	string	Общепринятый код валюты
decimal	int	Знаки, после запятой
---	---	---
reserv_value	float	Сумма резерва
course	dict	Курс обмена

Пример запроса

Laravel Http

use Illuminate\Support\Facades\Http;

$api_key = 'YOUR_API_KEY';
$base_url = 'https://your_domain/api/v2'
$response = Http::baseUrl($base_url)->withToken($api_key)->asJson()
                ->get('/operations/{id_валюты}')->json(); // operations/2

Пример ответа

200

{
    "data":{
        "1":{
            "id":1,
            "type":"direction",
            "attributes":{
                "buy_currency":{
                    "id":1,
                    "name":"СберОнлайн",
                    "currency_type":"РУБ",
                    "payment_name":"СберОнлайн",
                    "iso_code":"RUB",
                    "letter_cod":"SBERRUB",
                    "decimal":2
                },
                "reserv_value":948498141,
                "course":{
                    "rate":5584341.301011727
                }
            }
        }
    }
}

Детали операции

POST /operations/detail/{direction_id}

Получаем подробную информацию по выбранному направлению

Параметры запроса

Параметр	Обязательный	Описание
direction_id	Да	ID Направления обмена

Схема ответа

Параметр	Тип поля	Описание
data	dict	Информация о направлении
id	int	ID Направления обмена
type	string	Тип массива
attributes	dict	Параметры направлений
position_num_in	int	Позиция в списке отдаваемых валют для сортировки
in_currency	dict	Информация о валюте Отдаю
id	int	ID Валюты
letter_cod	string	Общепринятый код валюты
name	string	Название валюты
label_in	string	Сообщение для поля Отдаю
label_out	string	Сообщение для поля Получаю
error_message	string	Сообщение об ошибки ввода реквизитов
decimal	int	Кол-во знаков после запятой
field_in	dict	Доп. поля для Отдаю
field_out	dict	Доп. поля для Получаю
position_num_in	int	Позиция в списке получаемых валют для сортировки
out_currency	dict	Информация о валюте Получаю
id	int	ID Валюты
letter_cod	string	Общепринятый код валюты
name	string	Название валюты
label_in	string	Сообщение для поля Отдаю
label_out	string	Сообщение для поля Получаю
error_message	string	Сообщение об ошибки ввода реквизитов
decimal	int	Кол-во знаков после запятой
field_in	dict	Доп. поля для Отдаю
field_out	dict	Доп. поля для Получаю
--	--	--
course	dict	Курс обмена
min_in	float	Минимальная сумма для Отдаю
max_in	float	Максимальная сумма для Отдаю
min_out	float	Минимальная сумма для Получаю
min_out	float	Максимальная сумма для Получаю
cities	dict	Доступные Страны/Города для обмена наличных
fields	dict	Дополнительные поля для Направлений

Пример запроса

Laravel Http

use Illuminate\Support\Facades\Http;

$api_key = 'YOUR_API_KEY';
$base_url = 'https://your_domain/api/v2'
$response = Http::baseUrl($base_url)->withToken($api_key)->asJson()
                ->get('/operations/detail/{direction_id}')->json();

Пример ответа

200

{
    "data":{
        "id":1,
        "type":"direction",
        "attributes":{
            "position_num_in":0,
            "in_currency":{
                "id":2,
                "letter_cod":"BTC",
                "name":"Bitcoin BTC",
                "label_in":"С кошелька Bitcoin",
                "label_out":"На Bitcoin кошелек",
                "error_message":"",
                "decimal":8,
                "fields_in":{
                    "main":[],
                    "additional":[]
                },
                "fields_out": {
                    "main":[],
                    "additional":[]
                }
            },
            "position_num_out":0,
            "out_currency":{
                "id":1,
                "letter_cod":"SBERRUB",
                "name":"СберОнлайн",
                "label_in":"С номера карты",
                "label_out":"Номер карты to",
                "error_message":"",
                "decimal":2,
                "fields_in":{
                    "main":[],
                    "additional":[]
                },
                "fields_out":{
                    "main":[],
                    "additional":[]
                }
            },
            "course":{
                "rate":5584341.301011727
            },
            "min_in":1.8e-7,
            "max_in":0.02003904,
            "min_out":1,
            "max_out":110000,
            "cities":[],
            "fields":[]
        }
    }
}

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

GET your_domain/api/v2/account

200: OK

{
    "data":{
        "id":1,
        "type":"user",
        "attributes":{
            "name":"iEXUser",
            "email":"iex@domain",
            "locale":"ru",
            "created_at":1553401753,
            "last_visit":1709480844
        }
    }
}

Схема Ответа

Параметр	Тип поля	Описание
data	dict	Результаты запроса
data.id	int	ID Пользователя
data.type	string	Тип массива
data.attributes	dict	Информация о пользователе
data.attributes.name	string	Имя пользователя
data.attributes.email	string	E-mail пользователя
data.attributes.locale	string	Язык
data.attributes.created_at	int	Дата создания аккаунта
data.attributes.last_visit	int	Дата последнего посещения

API Валют и Курсов

Получение деталей направлений/валют

GET {ваш_домен}/api/v2/exchange/details

API Заявок

Создание новой заявки

POST {ваш_домен}/api/v2/order/create

Request Body

Name	Type	Description
direction*	String	Определяет, тип расчета сумм обмена. Может принимать одно из следующих значений: from - расчет от суммы "Отдаю" to - расчет от суммы "Получаю"
amount*	Float	Сумма обмена. Если direction=from то это сумма в валюте "Отдаю". Если direction=to то это сумма в валюте "Получаю"
phone	String	Номер телефона
email	String	E-mail клиента
income_account	String	Номер счета (Отдаю)
outcome_account	String	Номер счета (Получаю)
sender_fullname	String	Ф.И.О Отправителя (Для работы с Банками)
recipient_fullname	String	Ф.И.О Получаю (Для работы с Банками)
income_unk	String	Для crypto тэгов отдаю (Destination tag, Memo)
outcome_unk	String	Для crypto тэгов получаю (Destination tag, Memo)
fields_in	Array	Дополнительные поля валют "Отдаю"
fields_out	Array	Дополнительные поля валют "Получаю"
city_id	Array	ID Города (Для работы с Наличными)
country_id	Array	ID Страны (Для работы с Наличными)
direction_fields	Array	Дополнительные поля направлений
income_payment_system*	Integer	ID Валюты "Отдаю"
outcome_payment_system*		ID Валюты "Получаю"

200: OK

{
    "data": {
        "id":"1682076258673",
        "type":"order",
        "attributes": {
            "public_id":"1682076258673", // Номер заявки
            "created_at":"2023-04-21T14:24:18+03:00", // Дата создания
            "payment_system_from_id":3, // ID Валюты Отдаю
            "payment_system_to_id":10, // ID Валюты Получаю
            "fio_in":"",
            "fio_out":"",
            "is_new_user":1,
            "income_account":"Номер счета Отдаю",
            "outcome_account":"Номер счета Получаю",
            "is_click_button":0,
            "is_income_code":false,
            "income_amount": { // Сумма Отдаю
                "amount":0.808776,
                "currency":"ETH"
            },
            "outcome_amount": { // Сумма Получаю
                "amount":10,
                "currency":"LTC"
            },
            "income_qrcode": { // Данные по QR Code
                "is_qrcode":true,
                "prefix":"ethereum:",
                "value":"ethereum:eth?amount=0.808776"
            },
            "income_payment_timeout":300, // Время в течении которого необходимо оплатить заявку
            "pay_invoice_url":null, // Ссылка на оплату заявки (мерчант)
            "status":"waiting", // Статус заявки
            "payment_field": {
                "name":"",
                "value":"eth",
                "fields":[]
            },
            "is_email_verification":true,
            "is_verification":true,
            "is_black_list":false,
            "pay_merchant":false
        }
    }
}

Подтверждение создание заявки

POST {ваш_домен}/api/v2/order/confirm

Request Body

Name	Type	Description
id	Integer	ID Созданной заявки (берется из поля "data.attributes.public_id")

Отклонить созданную заявку

POST {ваш_домен}/api/v2/order/cancel

Request Body

Name	Type	Description
id	Integer	ID Созданной заявки (берется из поля "data.attributes.public_id")

Проверка статус созданной заявки

GET {ваш_домен}/api/v2/order/status

Request Body

Name	Type	Description
id	Integer	ID Созданной заявки (берется из поля "data.attributes.public_id")

200: OK

{
    "data": {
        "id":1682077248374,
        "public_id":"1682077248374",
        "type":"order_status",
        "attributes": {
            "created_at":"2023-04-21T11:40:48.000000Z",
            "is_paid":false,
            "is_handler":false,
            "status":"pending"
        }
    }
}

API Партнерской программы

Информация по партнерской программе

GET {ваш_домен}/api/v2/partner/info

Headers

Name	Type	Description
Content-type*	string	application/json
X-API-KEY*	string	YOUR_API_KEY

200: OK

Описание полей результата

Поле	Описание
status	Статус ответа от сервера: 0 - Успешный 1 - Неудачный
data.balance	Бонусы (за обмены и партнерские вознаграждения)
data.currency_payout	Символ валюты в которую получаете бонусы
data.min_payout	Минимальная сумма вывода бонусов

{
    "status":0,
    "data":{
        "balance":0,
        "currency_payout":"$",
        "min_payout":"0"
    }
}

Информация о партнерских переходах

GET {ваш_домен}/api/v2/partner/links

Headers

Name	Type	Description
Content-type*	string	application/json
X-API-KEY*	string	YOUR_API_KEY

Request Body

Name	Type	Description
from_date*	datetime	2023-04-03 10:00:58
to_date*	datetime	2023-05-05 23:59:00

200: OK

Описание полей результата

Поле	Описание
status	Статус ответа от сервера: 0 - Успешный 1 - Неудачный
data.created_at	Дата создания
data.ref_hash	Реферальный hash партнера
data.user_agent	Информация о браузере
data.ip_address	IP Адрес пользователя
data.cur_from	XML Код Отдаю (Пример: BTC)
data.cur_to	XML Код Получаю (Пример: SBERRUB)
data.views	Кол-во переходов

{
    "status":0,
    "data":[{
        "created_at":"2022-08-18 21:29:06",
        "ref_hash":"ref_hash",
        "user_agent":"User agent",
        "ip_address":"127.0.0.1",
        "cur_from":"BTC",
        "cur_to":"ETH",
        "views":11
    }]
}

Данные о партнерских обменах

GET {ваш_домен}/api/v2/partner/exchanges

Headers

Name	Type	Description
Content-type*	string	application/json
X-API-KEY*	string	YOUR_API_KEY

Request Body

Name	Type	Description
from_date*	datetime	2023-04-03 10:00:58
to_date	datetime	2023-04-03 10:00:58

200: OK

{
    "status":0,
    "data":[{
        "created_at":"2019-03-24 14:40:41",
        "order_id":328,
        "amount_in":"1",
        "amount_out":"8750.98",
        "rate":"1 ETH = 8750.98 руб.",
        "status_order":0,
        "partner_bonus":"2.00 руб",
        "partner_percent":0
    }]
}

Список партнерских выплат

GET https://{ваш_домен}/api/v2/partner/payouts

Headers

Name	Type	Description
Content-type*	string	application/json
X-API-KEY*	string	YOUR_API_KEY

Request Body

Name	Type	Description
from_date*	datetime	2023-04-03 10:00:58
to_date*	datetime	2023-05-05 23:59:00

200: OK

{
    "status":0,
    "data":[{
        "created_at":"2019-03-26 13:57:24",
        "status":1,
        "account":"R111111111111",
        "pay_amount":0,
        "pay_currency_name":"AdvCash",
        "pay_currency_code":"USD"
    }]
}