Аутентифікація і авторизація

Материал из UniqTrade API
Версия от 13:07, 4 июня 2021; Administrator (обсуждение | вклад) (Новая страница: «Обов'язково надсилайте заголовок '''''Content-Type''''': <pre> Content-Type: application/json </pre>»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску
Другие языки:
русский • ‎українська

Для отримання доступу до API, необхідно виконати вхід в свій обліковий запис, виконавши POST запит на URI

https://order24-api.utr.ua/api/login_check

Передавши в тілі запиту логін, пароль і підпис браузера, наприклад:

{
  "email":"[email protected]",
  "password":"mysecretpassword",
  "browser_fingerprint": "some-unique-key-here"
}

Де:
Email - логін користувача
Password - пароль користувача
Browser_fingerprint - підпис браузера, для API використовуйте будь-яку унікальну рядок довжиною не більше 128 символів. Ми, наприклад, використовуємо хеш md5();


Обов'язково надсилайте заголовок Content-Type:

Content-Type: application/json


На відправлений запит буде отримана відповідь в json-форматі:

{
    "token": "eyJ0eXAiOiJKV1Q...",
    "expires_at": "2020-01-17 15:04:50",
    "refresh_token": "2a3bb84af9a3..."
}

з якого необхідно витягти поля
token – токен, буде потрібно для авторизації при виконанні наступних запитів, має термін дії
refresh_token – токен, який буде потрібний для подальшого оновлення поля token, після закінчення його терміну дії

Наприклад, для пошуку деталі по артикулу OC90, посилаємо наступний запит:

https://order24-api.utr.ua/api/search/oc90 

додавши при цьому в headers

Authorization: Bearer eyJ0eXAiOiJKV1Q...<br>

Де в Authorization після ключового слова Bearer потрібно передати отриманий вище token.


Помилка аутентифікації

У разі зазначення неправильного імені користувача або пароля, ви отримаєте таку відповідь

  • Status Code: 401 Unauthorized
  • Body:
{
    "code": 401,
    "message": {
        "status": "401 Unauthorized",
        "message": "Bad credentials, please verify that your login/password are correctly set"
    }
}

У разі відсутності Authorization або відсутності ключового слова Bearer, ви отримаєте таку відповідь

  • Status Code: 401 Unauthorized
  • Body:
{
    "code": 401,
    "message": "JWT Token not found"
}

У разі зазначення неправильного Authorization ви отримаєте таку відповідь

  • Status Code: 401 Unauthorized
  • Body:
{
    "code": 401,
    "message": "Invalid JWT Token"
}


Оновлення простроченого token-у

В случае окончания срока действия token-а, вы получите следующий ответ

  • Status Code: 401 Unauthorized
  • Body:
{
    "code": 401,
    "message": "Expired JWT Token"
}

Для обновления значения просроченного token-а необходимо выполнить запрос POST запрос на URI

https://order24-api.utr.ua/api/token/refresh

передав в теле запроса значение refresh_token, полученный ранее:

{
    "refresh_token": "2a3bb84af9a3...",
    "browser_fingerprint": "some-unique-key-here"
}

Где:
refresh_token – рефреш токен полученный ранее.
browser_fingerprint – подпись браузера, строка должна быть аналогичная той которая использовалась при авторизации.

На отправленный запрос будет получен ответ в json-формате:

{
    "token": "eyJ0eXAiOiJKV1Q...",
    "expires_at": "2020-01-17 15:14:50",
    "refresh_token": "2a3bb84af9a3..."
}

При отсутствии или указании неверного значения refresh_token, вы получите следующий ответ

  • Status Code: 401 Unauthorized
  • Body:
{
    "code": 401,
    "message": {
        "status": "401 Unauthorized",
        "message": "Bad credentials, please verify that your login/password are correctly set"
    }
}