Документация WEEX API: как начать работу с торговым API WEEX

Чтобы начать работу с WEEX API, нужны две вещи: официальная документация WEEX API и API-ключ, настроенный для необходимых вам функций. WEEX предоставляет ресурсы API для спотовой торговли и торговли фьючерсами USDT-M. Документация охватывает рыночные данные, функции аккаунта, торговые операции, REST API и подключения WebSocket.

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

Настройка несложна: выберите соответствующую документацию WEEX API, создайте API-ключ, настройте необходимые разрешения, защитите учетные данные и подключите приложение к нужной конечной точке API.

Где найти официальную документацию WEEX API?

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

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

WEEX разделяет 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 задается пользователем и необходима для аутентифицированного доступа. Если парольная фраза утеряна, WEEX сообщает, что ее невозможно восстановить, и потребуется создать новый API-ключ. Эти учетные данные следует хранить в безопасном месте и никому не передавать.

Как настроить разрешения WEEX API

Для нового API-ключа WEEX Spot по умолчанию установлено разрешение «Только чтение». Оно позволяет ключу обращаться к поддерживаемым функциям запросов, но не дает разрешения на выполнение операций спотовой торговли.

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

Таким образом, выбор разрешений зависит от задач приложения. Инструмент, предназначенный только для мониторинга балансов, просмотра истории торговли или анализа информации, может оставаться в режиме «Только чтение». Приложению для исполнения спотовых ордеров потребуется разрешение на спотовую торговлю.

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

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

Как подключиться к WEEX REST API

Когда API-ключ и разрешения готовы, можно подключить приложение к WEEX REST API. 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-адресам и надежно хранить APIKey, SecretKey и Passphrase.

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

Перед использованием 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. Утерянную парольную фразу восстановить нельзя, поэтому в таком случае необходимо создать новый API-ключ.

4. Какие разрешения есть у нового API-ключа WEEX?
Для нового API-ключа Spot по умолчанию установлено разрешение «Только чтение». Чтобы выполнять операции спотовой торговли, необходимо включить соответствующее разрешение на спотовую торговлю.

5. Почему мой запрос к WEEX API не работает?
К распространенным причинам относятся неверные учетные данные, недостаточные разрешения, ошибки подписи, расхождения временных меток, ограничения по IP или лимиты запросов. В зависимости от полученной ошибки проверьте соответствующий раздел официальной документации WEEX API.