Описание
Для работы с API сервисом необходимо запросить токен использующийся для идентификации пользователя в сервисе и разрешающий доступ к данным. Получернный токен будет необходим во все остальных шагах, для работы c сервисом.
Формат запроса
[apirms.ru/techapi/]?[get=token]&[login=ваш_логин]&[pass=ваш_пароль]
Пример запроса
apirms.ru/techapi/?get=token&login=ваш_логин&pass=ваш_парольПараметры запроса
Параметр | Описание |
---|---|
apirms.ru/techapi/ | Путь к ресурсу |
get=token | Метод получения токена пользователя |
login=ваш_логин | Логин пользователя |
pass=ваш_пароль | Пароль пользователя |
Возвращаемые данные
В случае выполнения успешного запроса, возвращается массив с двумя элементами: 'status' со значением 'successful' означающем, что запрашиваемые данные получены и 'result' в котором представлены возвращаемые данные в виде значения или массива 'items' значений, элементы которых представлены в таблице.
Элемент | Значение |
---|---|
result | Ваш токен |
Возвращаемые ошибки
В случае не удачного выполнения запроса, возвращается массив с двумя элементами: 'status' со значение 'error' означающем, что запрашиваемые данные не получены и 'result' в котором представлены возвращаемые ошибки в виде массива значений, 'code' - код ошибки и 'message' - текстовое значение ошибки, данные которых представлены в таблице.
Код | Значение |
---|---|
100 | create token error |
200 | no user |