Що таке WhiteBIT API?

WhiteBIT API - це інструмент автоматизації, який дає змогу розробникам створювати програми та додатки для взаємодії з нашою біржею. З його допомогою можна виконувати такі дії, як-от: створення та управління ордерами на купівлю і продаж криптовалют, отримання інформації про ринок, баланс облікового запису й багато іншого.

Як використовувати WhiteBIT API?

Перш перейти до використання API, потрібно увімкнути двофакторну аутентифікацію (2FA) на акаунті.

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

Для активації ключів дотримуйтесь простих інструкцій:

  • Перейдіть у розділ налаштування API у вашому обліковому записі та виберіть "Редагувати" у відповідній секції;
  • Після натискання "Згенерувати ключ API", введіть свій код 2FA;
  • У вікні, що з'явилося, ви побачите пару API ключів - обов'язково збережіть їх, оскільки вони знадобляться для подальшої аутентифікації операцій в API інтерфейсі.

 

Переконайтеся, що ви надійно зберігаєте свій Секретний ключ, оскільки після закриття цієї сторінки він буде недоступний для відновлення. Водночас ваш Публічний ключ завжди доступний, і він не несе загрози під час передавання третім особам. На відміну від Секретного ключа, Публічний ключ сам по собі практично не створює підстав для небажаних дій.

  • На цій же сторінці ви також можете вибрати кінцеві точки (endpoint), які ви плануєте використовувати. З метою тестування API ключів рекомендується вибрати всі доступні кінцеві точки, оскільки в майбутньому ви зможете відредагувати цей вибір. Більш детальна інформація про кінцеві точки буде представлена далі в статті;
  • Потім, підтвердьте свої дії, ввівши код 2FA;
  • І ось, ваші API ключі готові до використання!

 

Після створення пари API ключів також можна змінити IP-доступ. За допомогою функції обмеження доступу за IP-адресами можна внести власні IPv4 і IPv6 адреси до списку довірених IP-адрес.

У разі активації цієї функції, якщо запит на отримання ключів API буде надіслано з іншої IP-адреси, ключі API автоматично деактивуються. На електронну адресу буде надіслано повідомлення із зазначенням публічного ключа та IP-адреси, з якої було надіслано запит.

Якщо ця IP-адреса належить вам і є довіреною, то API можна знову активувати, додавши її до списку довірених IP-адрес.

Загалом можна додати до списку довірених IP-адрес до 5 адрес.

Якщо повернутися до списку доступних Кінцевих точок (endpoint) для використання, варто звернути увагу, що кожна з представлених категорій і підкатегорій відповідає за свою групу операцій для управління акаунтом на біржі. Ви можете створювати й використовувати ваші ключі для виконання операцій в одній або декількох із таких доступних категорій:

  • Поповнення
  • Виведення
  • Переказ між балансами
  • Баланс та історія гаманця
  • Коди
  • Торговий баланс та історія
  • Управління ордерами

 

Детальнішу інформацію про функціонал API нашої біржі можна знайти в технічній інструкції, представленій у простому і доступному форматі.

Розширена документація також розміщена в загальнодоступному репозиторії програмного забезпечення на GitHub.

 

Для тестування функціонала нашого API ви також можете скористатися DEMO-токенами.

WhiteBIT Webhook

Webhook використовується для отримання зворотного зв'язку від сервера про виконання різних процесів на вашому акаунті, як-от успішне виведення коштів чи активація WB-коду.

Для активації ключів Webhook необхідно виконати аналогічні кроки, як і для API ключів у розділі налаштувань Webhook у вашому акаунті. Є кілька способів активації:

  • Додавання публічного ключа до запису домену TXT, зазначеного під час створення ключа;
  • Додавання файлу "whiteBIT-verification.txt" із вмістом вашого публічного ключа Webhook у кореневу папку вашого сайту;
  • Створення кінцевої точки "check-wb-webhooks" на вашому сервері, яка повертатиме відкритий ключ Webhook.

 

Для початку активації ключа Webhook вам потрібно створити його на біржі. Варто враховувати, що створити можна тільки один ключ Webhook. Щоб це зробити, виконайте такі кроки:

  • Перейдіть у розділ налаштувань Webhook у вашому обліковому записі та виберіть "Редагувати" у відповідній секції;
  • Як і при створенні ключів API, обов'язково збережіть Секретний ключ у безпечному місці. Після закриття сторінки кнопкою "Підтвердити", Секретний ключ більше не буде доступний;
  • Готово! Ключі Webhook буде створено.

 

Зверніть увагу, що, так само як і у випадку з ключами API, створення ключа Webhook не вмикає його автоматично. Необхідно перевести повзунок в активне положення, щоб активувати Webhook.

Детальнішу інформацію про налаштування та використання Webhook можна знайти у відповідному розділі нашої Webhook документації.

Які питання виникають найчастіше?

Що станеться з API і Webhook ключами в разі вимкнення двофакторної аутентифікації 2FA?

  • У разі вимкнення 2FA, ваші API і Webhook ключі буде вимкнено, і активувати їх можна буде знову тільки після ввімкнення 2FA.

 

Чи можливо створювати й активувати API та Webhook ключі через мобільний додаток WhiteBIT?

  • На жаль, ні. Процес створення та активації ключів доступний тільки у вебверсії нашої біржі.

 

Чи є у ключів API термін дії і яку їх кількість можна створити?

  • Якщо ключ API залишається неактивним протягом 14 днів, його буде автоматично деактивовано з метою підтримання безпеки. Максимальна доступна кількість становить 5 ключів.

 

Чи можна використовувати довільний домен для тестування роботи ключів Webhook?

  • Наша система не передбачає таких дій. Для активації ключа Webhook необхідно підтвердити право власності на домен.

Підтримка

У разі виникнення будь-яких питань, пов'язаних із функціоналом нашої біржі, ви можете:

  • Залишити запит на нашому сайті;
  • Написати на електронну пошту служби підтримки: support@whitebit.com;
  • Написати в чат, скориставшись кнопкою в правому нижньому кутку екрана (у застосунку WhiteBIT у лівому верхньому кутку перейдіть у розділ "Акаунт" — "Підтримка").

Чи була ця стаття корисною?

1 з 1 вважають статтю корисною