Versions Compared

Old Version 1

changes.mady.by.user Natalia Chernichko

Saved on

compared with

New Version Current

changes.mady.by.user Alex Adrianov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Для авторизации необходимо вызвать функцию auth To authorise, call the auth function (https://<DOMAIN>/api/auth/) с параметрами with the parameters login (логин пользователяuser login) и and password (пароль пользователяuser password).

ПараметрыParameters:

  • login -
    • логин пользователя
  • user login
  • password -
    • пароль пользователя
  • user password

ОтветResponse:

  • status
    • OK -
    • авторизация прошла успешно
    • authorisation was successful
    • ERROR -
    • пользователя с указанным логином/паролем не существует
    • user with the specified login/password does not exist
  • response.message -
    • пояснение статуса в случае ошибки
  • status explanation in case of error
  • response.token -
    • токен для последующей авторизации для вызова других функций (длина 32 символа)

...

  • token for further authorisation for calling other functions (length 32 characters).

Token lifetime is 600 seconds.


Info
titleВажноAttention!

Примеры GET запросов были удалены, т. к. это не безопасно и они могут быть перехвачены посредством MITM атак или перехватом пакетов при использовании HTTP протокола.

Функционирование GET запросов осталось, но может быть удалено в будущих релизах.

Настоятельно рекомендуется использовать исключительно JSON POST запросы с заголовком Examples of GET queries have been removed as they are not secure and can be intercepted via MITM attacks or packet sniffing when using the HTTP protocol.

The GET query functionality remains, but may be removed in future releases.

It is strongly recommended to use exclusively JSON POST queries with Content-type: application/json header

Пример POST запроса по адресуExample of POST query to  http://<DOMAIN>/api/auth/

Code Block
languagejs
POST http://<DOMAIN>/api/auth/
Content-Type: application/json

{
	"login": "api",
	"password": "q4lrfb3"
}


Пример ответа об успешной авторизацииExample of a successful authorisation response:

Code Block
languagejs
{
	"status":"OK",
	"response": {
		"token": "3199c39700714eec4f6ada0b4242335b"
	}
}


ВажноImportant!!!

Параметр token необходимо передавать с запросом при вызове любой функции API кроме auth (в формате соответствующего типа передачи данных The token parameter must be passed with the query when calling any API function except auth (in the format of the corresponding data transfer type (POST, GET, PUT))Пример отправки данных POST запросом по адресу .


Example of sending data by POST query to http://<DOMAIN>/api/<SOME_FUNC>/

Code Block
languagejs
POST http://<DOMAIN>/api/<SOME_FUNC>/
Content-Type: application/json

{
	"token": "<TOKEN>",
	"param_1": "a",
	"param_2": "b"
}

...