You are here: Home / 2013 / Июнь / 28 / mapSurfer — rest — auth

mapSurfer — rest — auth

28 июня 2013 admin
назад
mapSurfer / Руководство разработчика REST / Авторизация

POST /auth/token

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

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

Ответ:

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

Формат: json

{
{
    "token": "ethryhetyjtyj",
    "refreshToken": "ethryhetyjtyj",
    "ttl": 3600
}
}


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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /auth/token/refresh

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


GET /auth/token/refresh?refreshToken=738975947453
}

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

Ответ:

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

Формат: json

{
    "token": "ethryhetyц4564",
    "refreshToken": "yrjryukryukryu",
    "ttl": 3600
}
}

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /auth

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


GET /auth?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

{
    "authenticated": true,
    "user": {
        "id": 11,
        "name": "Пользователь",
        "right": {
            "id": 1,
            "name": "Права",
            "admin": false,
            "mapExtent": {
                "id": 2,
                "name": "Republic of Tatarstan",
                "extent": {
                    "minX": 46.09270788877181,
                    "minY": 53.99190870342375,
                    "maxX": 55.299713101706935,
                    "maxY": 56.68378708907719,
                    "projection": "EPSG:4326"
                }
            }
        }
    }
}
}

// true, если пользователь авторизован, иначе false, булевое поле
// данные о пользователе, если он авторизован, объект
// id пользователя, целое число
// имя пользователя, строка
// данные о группе прав, объект
// id группы прав, целое число
// название группы прав, строка
// имеются ли права админа, булевое поле
// данные о границе карты для данной группы прав, объект
// id границы карты, целое число
// название границы карты, строка
// область видимости карты, объект
// минимальный x, число с плавающей точкой
// минимальный y, число с плавающей точкой
// максимальный x, число с плавающей точкой
// максимальный y, число с плавающей точкой
// проекция

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

Формат: text/plain

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

GET /logout

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


GET /logout?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

{
    "status": "ok"
}

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

Формат: text/plain

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

Posted in