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