Для авторизации необходимо вызвать функцию auth (https://<DOMAIN>/api/auth/) с параметрами login (логин пользователя) и password (пароль пользователя).
Параметры:
login - логин пользователя
password - пароль пользователя
Ответ:
status
OK - авторизация прошла успешно
ERROR - пользователя с указанным логином/паролем не существует
response.message - пояснение статуса в случае ошибки
response.token - токен для последующей авторизации для вызова других функций (длина 32 символа)
Время жизни токена 600 секунд.
Важно!
Примеры GET запросов были удалены, т. к. это не безопасно и они могут быть перехвачены посредством MITM атак или перехватом пакетов при использовании HTTP протокола.
Функционирование GET запросов осталось, но может быть удалено в будущих релизах.
Настоятельно рекомендуется использовать исключительно JSON POST запросы с заголовком Content-type: application/json
Пример POST запроса по адресу http://<DOMAIN>/api/auth/
POST http://<DOMAIN>/api/auth/
Content-Type: application/json
{
"login": "api",
"password": "q4lrfb3"
}
Пример ответа об успешной авторизации:
{
"status":"OK",
"response": {
"token": "3199c39700714eec4f6ada0b4242335b"
}
}
Важно!!!
Параметр token необходимо передавать с запросом при вызове любой функции API кроме auth (в формате соответствующего типа передачи данных (POST, GET, PUT))
Пример отправки данных POST запросом по адресу http://<DOMAIN>/api/<SOME_FUNC>/
POST http://<DOMAIN>/api/<SOME_FUNC>/
Content-Type: application/json
{
"token": "<TOKEN>",
"param_1": "a",
"param_2": "b"
}
Add Comment