Перед началом
Добро пожаловать в официальную документацию BeRLoga18_bot API.
Что бы использовать API, Вам нужен API key. Свяжитесь с нами https://t.me/BerlogaTex что бы его получить.
Авторизация
BeRLoga18_bot API ожидает получить в параметрах каждого вашего запроса apiKey.
apiKey
- ваш публичный ключ;
В ответ, Вам всегда возвращается JSON строка, в которой имеется обьязательные поля:
status
может быть ok
и error
При статусе ok
возвращается поле data
в котором находится ответ на запрос
{
"status":"ok",
"data":{
"id":1
}
}
При статусе error
возвращается полеerror
в котором находится сообщение об ошибке
{"status":"error","error":"Order already processed"}
Создание заявки с криптовалютой
Чтобы создать новую заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://boltt.ru/api/?new-order-crypto
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
amount | Integer | Да | Сумма обмена. |
cryptocurrency | String | Да | Криптовалюта (BTC) |
cryptocurrency_wallet | String | Да | Крипто-адрес. |
callback_url | String | Нет | На этот адрес вы получите пустой GET запрос как только средства будут зачислены |
Ответ data
Поле | Тип | Описание |
---|---|---|
orderId | Integer | ID Вашей заявки в системе. |
amountExc | Integer | Сумма которую нужно первести |
amountCrypto | Float | Сумма которую получите в криптовалюте |
paymentData | Long | Реквизиты. |
Создание заявки
Чтобы создать новую заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://boltt.ru/api/?new-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
amount | Integer | Да | Сумма обмена. |
callback_url | String | Нет | На этот адрес вы получите пустой GET запрос как только средства будут зачислены |
Ответ data
Поле | Тип | Описание |
---|---|---|
orderId | Integer | ID Вашей заявки в системе. |
amountExc | Integer | Сумма которую нужно первести |
paymentData | Long | Реквизиты. |
Получение списка заявок
Чтобы получить список заявок, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://boltt.ru/api/?get-orders
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
status | String | Нет |
Статуст заявки: waiting : Заявка ожидает оплаты или подвержденияconfirmed : Заявка подтвержденаdeclined : Заявка отклонена
|
offset | Integer | Нет | Отступ, пропуск указанного количества строк |
Ответ data
Поле | Тип | Описание |
---|---|---|
id | Integer | ID заявки |
type | String | Тип заявки |
status | String | Статус заявки |
amount_exchange | Integer | Сумма к получению |
amount_without_com | Integer | Сумма без комиссии |
amount_with_com | Integer | Сумма с комиссией |
date | String | Дата создание заявки |
date_processing | String | Дата обработки заявки |
Проверка статуса заявки
Чтобы проверить заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://boltt.ru/api/?check-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
orderId | Integer | Да | ID Вашей заявки |
Ответ data
Поле | Тип | Описание |
---|---|---|
status | String | Статус заявки |
Cтатус | Описание |
---|---|
waiting | Заявка ожидает оплаты или подверждения |
confirmed | Заявка подтверждена |
declined | Заявка отклонена |
timeout | Вышло время на оплату заявки |
error | Ошибка |
Отмена заявки
Чтобы отменить заявку, Вам нужно сделать вызов следующего адреса, с параметрами (POST) :
https://boltt.ru/api/?cancel-order
Параметры
Поле | Тип | Обьязательный | Описание |
---|---|---|---|
apiKey | String | Да | Ваш API key. |
orderId | Integer | Да | ID Вашей заявки |
Ответ status
Поле | Тип | Описание |
---|---|---|
status | String | Статус заявки (ok или error) |
Ошибки
Вы можете получить следующий текст ошибок
Текст ошибки | Описание |
---|---|
Api key invalid |
Некорректный API ключ
|
Api key disabled |
API ключ отключён
|
Invalid amount | Некорректная сумма обмена |
Minimum exchange amount {amount} | Сумма обмена меньше, чем минимальный порог |
No cards available | Нет доступных реквизитов |
Error creating order | Ошибка при создании заявки |
Invalid crypto currency | Неверная криптовалюта |
Invalid crypto address | Неверный крипто-адрес |
Invalid callback URL | Некорректный callback URL |
Invalid ID | Некорректный ID заявки |
Access is denied | Доступ закрыт |
Order already processed | Заявка уже обработана |
No data | Данных нет |