Документация по работе с GiraffeAPI.
Справка:
1) Запросы для которых нужна Bearer JWT авторизация помечены красным цветом, остальные синим;
2) Тип метода написан в скобках после имени запроса;
3) Все маршруты можно посмотреть и протестировать через интерфейс Swagger введя /api к адресу сайта в URL запросе.
4) Запросы включающие в себя query параметры выглядят так:
/api/auth/forgot-password/{email}, где {email} означает почту которая должна быть отправлена в url запросе, например: /api/auth/forgot-password/strangemisterio78@gmail.com;
5) Query под названием {interval} в ссылке запроса является обязательным. В поле можно ввести ОДИН из приведенных параметров: day/yesterday/week/month/all – для получения записей по временным промежуткам соответственно.
API эндпоинты запросов к данным:
АВТОРИЗАЦИЯ ДЛЯ ПОЛЬЗОВАТЕЛЕЙ ERP СИСТЕМЫ:
- Войти (POST): /api/auth/login
- Выйти (GET): /api/auth/logout
- Обновление пары JWT токенов (GET): /api/auth/refresh-tokens
- Отправления письма для восстановления пароля (GET): /api/auth/forgot-password/{email}
- Сброс пароля (POST): /api/auth/reset-password
ДЕЙСТВИЯ С ПОЛЬЗОВАТЕЛЕМ ERP СИСТЕМЫ:
- Получить всех пользователей (GET): /api/erp-user/all
- Получить пользователя (GET): /api/erp-user/{id}
- Получить информацию о себе (GET): /api/erp-user
- Редактировать пользователя (PATCH): /api/erp-user/{id}
- Удалить пользователя (DELETE): /api/erp-user/{id}
ДЕЙСТВИЯ С МОДЕЛЬЮ САМОКАТА:
- Создать модель самоката (POST): /api/scooter-model
- Получить все модели самоката (GET): /api/scooter-model
- Получить модель самоката (GET): /api/scooter-model/{id}
- Редактировать модель самоката (PATCH): /api/scooter-model/{id}
- Удалить модель самоката (DELETE): /api/scooter-model/{id}
ДЕЙСТВИЯ С САМОКАТОМ:
- Создать самокат (POST): /api/scooter
- Получить все самокаты (GET): /api/scooter
- Получить самокат (GET): /api/scooter/{id}
- Редактировать самокат (PATCH): /api/scooter/{id}
- Удалить самокат (DELETE): /api/scooter/{id}/{rightechScooterId} – берется 2 id чтоб удалить и наше представления скутера и представление скутера в сервисе rightech
ДЕЙСТВИЯ С ТАРИФАМИ:
- Создать тариф (POST): /api/tariff
- Получить все тарифы (GET): /api/tariff
- Получить тариф (GET): /api/tariff/{id}
- Редактировать тариф (PATCH): /api/tariff/{id}
- Удалить тариф (DELETE): /api/tariff/{id}
ДЕЙСТВИЯ С ПРОМОКОДАМИ:
- Создать промокод (POST): /api/promocode
- Получить все промокоды (GET): /api/promocode
- Получить промокод (GET): /api/promocode/{id}
- Редактировать промокод (PATCH): /api/promocode/{id}
- Удалить промокод (DELETE): /api/promocode/{id}
ДЕЙСТВИЯ С ПОЕЗДКАМИ:
- Создать поездку (POST): /api/promocode
- Получить все поездки (GET): /api/promocode/{interval}
- Получить поездку (GET): /api/promocode/{id}
- Редактировать поездку (PATCH): /api/promocode/{id}
- Удалить поездку (DELETE): /api/promocode/{id}
ДЕЙСТВИЯ С СТАТИСТИКОЙ:
- Получить статистику (GET): /api/stats/{interval}
- ДЕЙСТВИЯ С ТИПАМИ ГЕОЗОН:
- Создать типы (POST): /api/geofence/types – !!!ДАННЫЙ ЗАПРОС ВЫПОЛНЯЕТСЯ ЕДИНОЖДЫ ПРИ РАЗМЕЩЕНИИ ПРИЛОЖЕНИЯ С НУЛЯ !!!
- Получить все типы (GET): /api/geofence/types
ДЕЙСТВИЯ С ГЕОЗОНАМИ:
- Создать геозону (POST): /api/geofence
- Получить все геозоны (GET): /api/geofence
- Удалить геозону (DELETE): /api/geofence/{id}
ДЕЙСТВИЯ С ПОЛЬЗОВАТЕЛЕМ МОБИЛЬНОГО ПРИЛОЖЕНИЯ:
- Создать пользователя (POST): /api/user
- Получить всех пользователей (GET): /api/user
- Получить пользователя (GET): /api/user/{id}
- Редактировать пользователя (PATCH): /api/user/{id}
- Удалить пользователя (DELETE): /api/user/{id}
ДЕЙСТВИЯ С ПОДПИСКАМИ:
- Создать подписку (POST): /api/subscription
- Получить подписки (GET): /api/subscription
- Получить подписку (GET): /api/subscription/{id}
- Редактировать подписку (PATCH): /api/subscription/{id}
- Удалить подписку (DELETE): /api/subscription/{id}