/
Авторизація

Авторизація

Owned by Natalia Chernichko
Last updated: 2024 May 01

Для авторизації необхідно викликати функцію 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"
}


Related content