Что такое 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-адресов до 20 адресов.

Возвращаясь к списку доступных Конечных точек (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 дней, он будет автоматически деактивирован в целях обеспечения безопасности. Максимальное доступное количество составляет 20 ключей.

 

Можно ли использовать произвольный домен для тестирования работы ключей Webhook?

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

Поддержка

В случае возникновения любых вопросов, связанных с функционалом нашей биржи, вы можете:

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

Была ли эта статья полезной?

Пользователи, считающие этот материал полезным: 1 из 1