📚 API Документация

Введение

NS Registration API предоставляет endpoints для получения информации о пользователях и их QR-кодах.

1️⃣ Получить данные одного пользователя

GET
/api/user/<user_id>/

Параметры:

Параметр Тип Описание
user_id string 8-значный ID пользователя

Пример запроса:

GET /api/user/19606241/

Пример ответа (200 OK):

{
  "id": "19606241",
  "first_name": "Абылай",
  "last_name": "Мирзахан",
  "qr_code": "http://127.0.0.1:8000/media/qrcodes/19606241.png"
}

2️⃣ Получить список всех пользователей

GET
/api/users/

Параметры:

Нет параметров

Пример запроса:

GET /api/users/

Пример ответа (200 OK):

{
  "users": [
    {
      "id": "19606241",
      "first_name": "Абылай",
      "last_name": "Мирзахан",
      "qr_code": "http://127.0.0.1:8000/media/qrcodes/19606241.png"
    },
    {
      "id": "12345678",
      "first_name": "Иван",
      "last_name": "Петров",
      "qr_code": "http://127.0.0.1:8000/media/qrcodes/12345678.png"
    }
  ],
  "total": 2
}

⚙️ Коды ответов

Код Описание
200 OK - Успешный запрос
404 Not Found - Пользователь не найден
500 Internal Server Error - Ошибка сервера

🧪 Тестирование

Вы можете протестировать API используя:

  • cURL: curl http://127.0.0.1:8000/api/users/
  • Python requests: requests.get('http://127.0.0.1:8000/api/users/')
  • Postman: Импортируйте URL и отправьте GET запрос
  • JavaScript fetch:
    fetch('http://127.0.0.1:8000/api/users/')
      .then(response => response.json())
      .then(data => console.log(data))

ℹ️ Дополнительная информация

  • Все ответы в формате JSON
  • QR-код содержит только 8-значный ID пользователя
  • QR-коды сохраняются в PNG формате
  • API доступен без аутентификации