API Автомобильных марок, моделей и модификаций

Общие сведения

  • Авторизация: Basic Auth (для Внешнего API)
  • Все ответы — JSON
  • В случаях ошибок возвращается JSON с полем "error"
  • Базовый URL внешнего API: /api/v1/

1. Marks (Марки автомобилей)

Внешний API (C Basic Auth)

GET /api/auto?action=marks

Получить список марок автомобилей с суммарным заказом.

  • Метод: GET
  • Авторизация: Basic Auth (требуется)
  • Описание: Возвращает список не удалённых марок авто с подсчитанным по всем моделям суммарным количеством заказов (order). Параметры (query):
  • action=marks — обязательный параметр

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

/api/auto?action=marks

Пример ответа:

[
  {
    "id": 1,
    "name": "Toyota",
    "order": 1500
  },
  {
    "id": 2,
    "name": "Honda",
    "order": 1200
  }
]

2. Models (Модели автомобилей по марке)

Внешний API (C Basic Auth)

GET /api/auto?action=models&mark_id={mark_id}

Получить список моделей по ID марки.

  • Метод: GET
  • Авторизация: Basic Auth (требуется) Параметры (query):

action=models — обязательный параметр

mark_id (число) — ID марки автомобиля, обязательный параметр

  • Описание: Возвращает список моделей, принадлежащих указанной марке, не удалённых, отсортированных по имени.

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

/api/auto?action=models&mark_id=1

Пример ответа:

[
  {
    "id": 10,
    "name": "Camry",
    "order": 10
  },
  {
    "id": 12,
    "name": "Corolla",
    "order": 12
  }
]

3. Modifications (Модификации модели)

Внешний API (C Basic Auth)

GET /api/auto?action=modifications&model_id={model_id}

Получить список модификаций по ID модели.

  • Метод: GET
  • Авторизация: Basic Auth (требуется)

Параметры (query):

action=modifications — обязательный параметр

  • model_id (число) — ID модели автомобиля, обязательный параметр

  • Описание: Возвращает список модификаций указанной модели, не удалённых, отсортированных по имени с учётом пустых названий (заменяются на "Без названия").

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


/api/auto?action=modifications&model_id=10

Пример ответа:

[
  {
    "id": 100,
    "name": "1.8L 150hp",
    "order": 100
  },
  {
    "id": 101,
    "name": "Без названия",
    "order": 101
  }
]