Документація WEEX API: як почати роботу з торговим API WEEX

Щоб почати роботу з API WEEX, потрібні дві речі: офіційна документація API WEEX і ключ API, налаштований для потрібних вам функцій. WEEX надає ресурси API для спотової торгівлі та ф’ючерсної торгівлі USDT-M, а документація охоплює ринкові дані, функції облікового запису, торгові операції, REST API та підключення WebSocket.

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

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

Де знайти офіційну документацію WEEX API?

WEEX підтримує окрему документацію для своїх продуктів і інтерфейсів API. Документація оновлюється в міру змін функцій API, а на окремих сторінках ендпоінтів наведено приклади запитів і відповідей для інтеграції. 

Документація Spot V3 охоплює підготовку, домени API, автентифікацію, ринкові дані, функції облікового запису, функції ордерів, підключення WebSocket, обмеження частоти запитів та інші технічні вимоги.

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

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

Як створити ключ API WEEX

Щоб користуватися приватними функціями WEEX API, спершу потрібно створити ключ API в обліковому записі WEEX. Згідно з актуальною документацією Spot V3, основні кроки такі:

1. Увійдіть у WEEX через вебплатформу.
2. Відкрийте розділ керування API та створіть новий ключ API.
3. Налаштуйте дозволи, потрібні для інтеграції.
4. За потреби прив’яжіть IP-адресу.
5. Надійно збережіть облікові дані API, згенеровані або налаштовані під час цього процесу.

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

Під час створення ключа API важливі три облікові дані: APIKey ідентифікує користувача API для автентифікації. SecretKey — це приватний ключ, який використовується для створення підписів запитів.

Passphrase задає користувач, і він потрібен для автентифікованого доступу. Якщо Passphrase втрачено, WEEX зазначає, що його неможливо відновити, і потрібно створити новий ключ API. Ці облікові дані слід зберігати в безпечному місці й не передавати іншим людям.

Як налаштувати дозволи WEEX API

Новий ключ Spot API WEEX за замовчуванням має дозвіл «Лише читання». Він дає ключу доступ до підтримуваних функцій запитів, але не дозволяє виконувати операції спотової торгівлі.

Якщо застосунку потрібно розміщувати або скасовувати спотові ордери, слід увімкнути відповідний дозвіл на спотову торгівлю.

Отже, потрібний дозвіл залежить від завдань застосунку. Інструмент, який використовується лише для моніторингу балансів, перегляду історії торгівлі або аналізу інформації, може залишатися в режимі «Лише читання». Для застосунку, призначеного для виконання спотових ордерів, потрібен дозвіл на спотову торгівлю.

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

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

Як підключитися до REST API WEEX

Коли ключ API та дозволи готові, можна підключити застосунок до REST API WEEX. WEEX надає ендпоінти REST API для ринкових даних, інформації про обліковий запис і підтримуваних торгових операцій.

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

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

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

Як перевірити підключення до WEEX API

Простий спосіб розпочати інтеграцію — переконатися, що застосунок може успішно обмінюватися даними з WEEX API, перш ніж додавати складніші торгові функції.

Спершу можна використовувати запити до публічного API, оскільки для них не потрібна автентифікація. Коли базове підключення запрацює, можна перевірити автентифіковані запити відповідно до дозволів, призначених ключу API.

Якщо автентифікований запит не виконується, потрібно перевірити кілька елементів налаштування. Серед них — облікові дані API, дозволи, підпис запиту, мітка часу, домен API та обмеження за IP-адресою.

Для автентифікованих запитів WEEX вимагає використовувати стандартизований метод підпису. Згідно з актуальною документацією V3, мітка часу запиту вимірюється в мілісекундах, а запит може бути відхилено, якщо мітка часу відрізняється від часу сервера WEEX API більш ніж на 30 секунд. 

Поетапна перевірка підключення допомагає визначити, чи проблема пов’язана зі з’єднанням, автентифікацією, дозволами або конкретним запитом.

Що перевірити перед використанням WEEX API для торгівлі?

Перш ніж використовувати WEEX API для торгівлі, перевірте дозволи ключа API й переконайтеся, що він має лише той доступ, який потрібен застосунку. WEEX також рекомендує прив’язувати ключі API до довірених IP-адрес і захищати ключ API, SecretKey та Passphrase.

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

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

Висновок

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

Розробники можуть спершу використовувати запити до публічного API, а потім перейти до автентифікованих функцій облікового запису або торгівлі. Актуальна документація WEEX API має залишатися основним технічним джерелом інформації про поточні ендпоінти, вимоги до автентифікації, дозволи й обмеження частоти запитів.

Поширені запитання

1. Де знайти офіційну документацію WEEX API?
WEEX надає окрему документацію з описом продуктів API, ендпоінтів, автентифікації, підключень WebSocket, параметрів і прикладів відповідей. Розробникам слід користуватися найновішою версією, оскільки функції API можуть оновлюватися.

2. Як створити ключ API WEEX?
Увійдіть у вебплатформу WEEX і відкрийте розділ керування API, щоб створити й налаштувати ключ API. Наразі кожен обліковий запис може створити до 10 груп ключів API.

3. Яку інформацію потрібно зберегти після створення ключа API WEEX?
Надійно збережіть APIKey, SecretKey і Passphrase. Відновити втрачену Passphrase неможливо, тому в разі її втрати потрібно створити новий ключ API.

4. Які дозволи має новий ключ API WEEX?
Для нового ключа Spot API за замовчуванням встановлено режим «Лише читання». Щоб виконувати операції спотової торгівлі, потрібно ввімкнути відповідний дозвіл на спотову торгівлю.

5. Чому мій запит до WEEX API не працює?
Серед поширених причин — неправильні облікові дані, недостатні дозволи, помилки підпису, розбіжності в мітках часу, обмеження за IP-адресою або ліміти запитів. Перевірте відповідний розділ офіційної документації WEEX API з огляду на помилку, яку повертає запит.