Cryptohopper

Авторизация

Авторизация OAuth2

Cryptohopper использует OAuth2 для предоставления авторизованного доступа к своему API.

Использование OAuth2

Понимание работы OAuth2 поможет создавать и отлаживать приложения, использующие API Cryptohopper. Для использования OAuth приложение должно:

  • Получить маркеры grant для действий от имени учётной записи пользователя.
  • Обменять маркеры grant на маркеры доступа.
  • Авторизовать все HTTP-запросы, отправляемые в API Cryptohopper.

Метод аутентификации пользователя позволяет приложению действовать от имени пользователя, как если бы это был сам пользователь.

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

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

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

Методы OAuth2

authorize

С помощью конечной точки authorize пользователи могут войти в Cryptohopper и предоставить доступ приложению. После успешной авторизации или при возникновении ошибок пользователь будет перенаправлен на URL перенаправления. Если URL перенаправления не указан в запросе, используется URL перенаправления из настроек приложения. В параметрах GET URL перенаправления вы получите токен grant, который можно обменять на access_token.

Конечная точка: https://www.cryptohopper.com/oauth2/authorize

Принимает: GET

Возвращает: code, state в GET в URL перенаправления

Параметры:

  • client_id: Ключ приложения.
  • response_type: Тип ответа должен содержать текст: code.
  • redirect_uri: URL перенаправления, куда будет перенаправлен пользователь после процесса OAuth.
  • state: Дополнительный параметр для идентификации запросов со стороны приложения. Будет возвращён в URL перенаправления.
  • scope: Список областей, разделённых запятыми, например: read,notifications,manage,trade.

 

token

Конечная точка token используется для обмена токеном grant/кодом на действительный access_token.

Конечная точка: https://www.cryptohopper.com/oauth2/token

Принимает: POST в формате application/json

Возвращает: access_token и refresh_token в формате application/json

Параметры:

  • client_id: Ключ приложения.
  • client_secret: Секрет приложения.
  • grant_type: Тип grant должен содержать текст: authorization_code.
  • redirect_uri: URL перенаправления приложения.
  • code: Токен grant/код.

 

Успешные коды ответов

Когда запрос к конечной точке access_token успешно выполнен, пользователь будет перенаправлен на URL перенаправления с токеном grant, переданным в параметрах GET.

Успешный запрос к токен-конечной точке будет иметь код ответа 200 и включать access_token в теле, который можно использовать для аутентификации API-вызовов.

Коды ответов об ошибках

Ошибки, возвращаемые в URL перенаправления, распознаются по возвращаемому параметру GET: error=1. Ниже приведены возможные сообщения об ошибках:

  • Ключ приложения недействителен.
  • Подпись недействительна.
  • Ключ приложения не может быть пустым.
  • Пользователь не предоставил разрешения приложению.