You are here: Home / 2015 / Январь / 19 / MapSurfer — rest — auth

MapSurfer — rest — auth

19 января 2015 admin
назад
mapSurfer GS / Руководство разработчика REST / Авторизация

POST /auth/token

Структура запроса:


POST /auth/token

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

Формат: json


{
    "login": "testlogin",
    "password": "12345"
}




// логин пользователя, строка
// пароль, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "token": "hwk12poi3f1",
    "refreshToken": "mbs90lon2a8",
    "ttl": 3600
}




// ключ доступа, строка
// ключ для обновления ключа доступа, строка
// время жизни ключа доступа в секундах, целое число

Статус: 401 — логин или пароль переданы неверно

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /auth/token/refresh

Структура запроса:


GET /auth/token/refresh?refreshToken=mbs90lon2a8

refreshToken: ключ для обновления ключа доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "token": "hwk12poi3f1",
    "refreshToken": "mbs90lon2a8",
    "ttl": 3600
}




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

Статус: 400 — не передан параметр refreshToken

Формат: text/plain

Содержит описание ошибки

Статус: 404 — параметр refreshToken не найден в системе

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /auth

Структура запроса:


GET /auth?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "authenticated": "true",
    "user": {
        "id": 1,
        "login": "admin",
        "name": "Администратор ведомств",
        "info": {
            "id": 1,
            "address": "Страна, город, улица",
            "phone": "+79655905559",
            "fax": "5173443",
            "email": "email@email.com",
            "inn": 253565322124,
            "kpp": null,
            "passport": "",
            "bank": "",
            "bankKpp": null,
            "bankBik": null,
            "bankSchet": ""
        },
        "organizationId": null,
        "roleId": 8,
        "role": {
            "id": 8,
            "title": "Администратор ведомств"
        }
    }
}




// true, если пользователь авторизован, иначе false, булевое поле
// данные о пользователе, если он авторизован, объект
// id пользователя, целое число
// логин пользователя
// имя пользователя, строка
// данные о пользователе, объект
// id пользователя, целое число
// адрес пользователя, строка
// телефон, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// паспортные данные, строка
// банковские данные, строка
// банк КПП, целое число
// банк БИК, целое число
// банковский счет, строка

// id организации, целое число
// id группы прав, целое число
// информация о группе прав, объект
// id группы прав, целое число
// название группы прав, строка

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /users/current

Структура запроса:


GET /users/current?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "user": {
        "id": 61,
        "login": "admin",
        "name": "Администратор ведомств",
        "info": {
            "id": 61,
            "address": "Страна, город, улица",
            "phone": "",
            "fax": "",
            "email": "",
            "inn": null,
            "kpp": null,
            "passport": "",
            "bank": "",
            "bankKpp": null,
            "bankBik": null,
            "bankSchet": ""
        },
        "organizationId": null,
        "roleId": 8,
        "role": {
            "id": 8,
            "title": "Администратор ведомств"
        }
    }
}




// данные о текущем пользователе, объект
// id пользователя, целое число
// логин пользователя, строка
// ФИО пользователя, строка
// дополнительная информация о пользователе
// id пользователя, целое число
// адрес пользователя, строка
// телефон, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// паспортные данные, строка
// банковские реквизиты, строка
// банк КПП, строка
// банк БИК, строка
// банковский счет, строка

// id организации, целое число
// id группы прав, целое число
// информация о группе прав, объект
// id группы прав, целое число
// название, строка

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /logout

Структура запроса:


GET /logout?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "status": "ok"
}

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Posted in