Описание API сервера - Программное обеспечение для пропускной системы на основе технологии NFC

Таблица 8 Описание API

URL

Метод

Параметры

Возвращает

Вариант

/login

POST

Phone - form-data

JSON {'token', 'id'} - ID пользователя и токен

Успех

Password - form-data

JSON { 'error_msg': 'Not authorized'}, код 401

Неправильный логин/пароль

JSON { 'error_msg': 'Bad parameters'}, код 400

Не заданы необходимые поля

/register

POST

Phone - form-data

JSON {User}, код 201, редирект на /users/id

Успех

Password - form-data

JSON { 'error_msg': 'User with phone %s already exists}, код 409

Пользователь уже существует

/users/{id:int}

GET

Id - параметр пути

JSON {User}, код 200

Успех

Token - аргумент

JSON { 'error_msg': 'Not authorized'}, код 401

Некорректный токен

JSON { 'error_msg': 'User not found'}, код 404

Пользователь не найден

PUT

Id - параметр пути

JSON {User}, код 200

Успех

Token - аргумент

JSON { 'error_msg': 'Not authorized'}, код 401

Некорректный токен

Password, f_name, s_name, t_name - аргументы

JSON { 'error_msg': 'User not found'}, код 404

Пользователь не найден

/cards/{user_id:int}

GET

User_id - параметр пути

JSON {Passcard}, код 200

Успех

Token - аргумент

JSON { 'error_msg': 'Not authorized'}, код 401

Некорректный токен

JSON { 'error_msg': 'User not found'}, код 404

Пользователь не найден

/encrypt

GET

Msg - сообщение для шифровки

JSON { 'msg': 'Encrypted message'}, код 200

Успех

JSON { 'error_msg': 'Bad parameters'}, код 400

Не указан параметр msg

/decrypt

GET

Msg - сообщение для расшифровки

JSON { 'msg': 'Decrypted message'}, код 200

Успех

JSON { 'error_msg': 'Bad parameters'}, код 400

Не указан параметр msg

/new_card

POST

Icon_url - ссылка на иконку

JSON {Passcard}, код 201

Успех

Header_url - ссылка на изображение для заголовка

Title - заголовок

JSON { 'error_msg': 'Not authorized'}, код 401

IP адрес клиента не входит в список доверенных

Subtitle - подзаголовок

Expired - время истечения пропуска в формате

/cards

GET

Id - идентификатор

JSON {Passcard list}, код 200

Успех

Is_expired - истек ли срок

DELETE

Title - заголовок

JSON { 'error_msg': 'Not authorized'}, код 401

IP адрес клиента не входит в список доверенных

/card_to_user

PUT

Card_id - идентификатор карты

JSON {User}, код 200

Успех

DELETE

Pass_id - идентификатор пропуска

JSON { 'error_msg': 'Not authorized'}, код 401

IP адрес клиента не входит в список доверенных

Похожие статьи




Описание API сервера - Программное обеспечение для пропускной системы на основе технологии NFC

Предыдущая | Следующая