Login

Запрос

POST /login

Тело запроса

{
  "login": "yourlogin@example.com",
  "password": "yourstrongpassword",
  "service": "ServiceName",
  "version": "1.0"
}

Attention

Все поля в данном запросе обязательны.

Описание полей

  • login - Ваш логин
  • password - Ваш пароль
  • service - Название используемого Вами сервиса

    Указанное название будет использоваться как подпись для всех действий выполняемых сервисом

  • version - Версия используемого Вами API

    На данный момент доступна только версия 1.0

Пример запроса

curl -H 'Content-Type: application/json' \
    -X POST \
    -d '{"login": "yourlogin@example.com", "password": "yourstrongpassword", "service": "ServiceName", "version": "1.0"}}' \
    direct.lptracker.ru/login

Пример ответа при успешном выполнении:

{
    "status": "success",
    "result": {
        "token": "Here will be your token"
    }
}

Пример ошибки:

{
  "status": "error",
  "errors": [
    {
      "code": 401,
      "message": "Invalid login or password"
    }
  ]
}

Подробней об ошибках вы можете почитать тут

Attention

Полученный в результате успешного выполнения данного запроса token (result.token) неодходимо добавлять к остальным запросам в заголовок в поле token.

/login - единственный запрос, передаваемый без токена.

Logout

Logout представляет собой POST запрос, в результате выполнения которого Ваш токен будет удален из базы.

Запрос

POST /logout

Несмотря на то что это POST-запрос - тело запроса тут не требуется

В заголовке запроса необходимо указать Ваш token, который Вы получили в результате предыдущего запроса.

Пример запроса

curl -H 'Content-Type: application/json' \
    -X POST \
    direct.lptracker.ru/logout

Пример ответа при успешном выполнении:

{
    "status": "success",
    "result": true
}

Важные дополнения

  • У токена есть "время жизни" - 24 часа. Если в течении этого периода не будет произведено никаких действий - токен станет недействительным.
  • С одного IP адреса можно авторизоваться только под 1-м пользователем lptracker.
  • С одного IP адреса может быть авторизовано сколько угодно сервисов.