Описание методов API админки
Для работы с API вам потребуется JWT токен. Его необходимо указать в заголовке Authorization в виде "Authorization: Bearer token".
JWT токен вы можете запросить для своего проектного менеджера.
При запросе множества элементов (аренд, счетов, пользователей и т.д.) по умолчанию включена пагинация, если не был передан соответствующий query-параметр для отключения пагинации. Если в запросе не указан параметр для запроса конкретной страницы и количества элементов на странице, то по умолчанию приходит 1-ая страница и 20 элементов соответственно.
Таблица - Query параметры общие для всех запросов:
Параметр | Значение |
|---|---|
pagination | булевое значение для получения запроса без/c пагинацией |
filter[created_from] | дата в unix timestamp или ISO 8691 |
filter[created_to] | дата в unix timestamp или ISO 8691 |
page | номер страницы при запросе с пагинацией |
per-page | количество объектов на одну страницу при запросе с пагинацией |
sort | название поля, по которому производить сортировку при запросе (работает не для всех полей, поля указаны в каждой из таблиц ниже) |
expand | дополнительные вложенные объекты, которые необходимо включить в ответ на запрос |
Если у сущности есть связь с другой (в теле ответа при запросе этой сущности приходят id других сущностей, например, у аренды есть user_id - id пользователя, совершившего аренду), то возможно одновременно получить в этом же запросе информацию о этой сущности посредством query параметра expand.
Пример: при запросе /rest/v1/rentals/archive/4?expand=user, можно получить данные о завершенной аренде с id=4, внутри которой будет объект, описывающий основные поля сущности пользователя, совершившего аренды. Если у сущности есть связь с сущностями User или Object, то возможно совершить общий поиск по ним.
Например, общий поиск по пользователю:
/rest/v1/rentals?filter[user.*]=gmail.com
/rest/v1/rentlas?filter[user.*]=7999999
/rest/v1/rentlas?filter[user.*]=Семён Общий поиск по ТС:
/rest/v1/rentals?filter[object.*]=А123БВ
/rest/v1/rentals?filter[object.*]=5de1613294d912001131a8161111
URL-путь | Описание |
|---|---|
| Получить все текущие аренды |
| Получить все завершенные аренды |
| Получить данные по одной конкретной аренде с указанным id |
| Получить все счета по аренде без пагинации |
Для запросов в таблице выше
Значения для параметра expand | Описание |
|---|---|
status_points | история смены статусов |
rate,rate_files | Оценка, фото оценки |
stop_files | фото завершения |
amount_stat | статистика оплаты |
last_story | получать последний комментарий при запросе аренды |
user | Получить информацию о пользователе, к которому относится аренда |
object | получить в запросе информацию о ТС,аренда которого была произведена |
tariff | Получить информацию о трафике |
URL-путь | Описание |
|---|---|
| Получение всех счетов |
| Получить данные по одному счету с указанным id |
Для запросов в таблице выше
Значения для параметра expand | Описание |
|---|---|
region | регион, к которому относится транзакция |
rental | аренда, к которой относится транзакция |
object | объект, к которому относится транзакция |
user | пользователь, к которому относится транзакция |
URL-путь | Описание |
|---|---|
| Получение всех транзакций |
| Получить данные по одной транзакции с указанным id |
Для запросов в таблице выше
Значения для параметра expand | Описание |
|---|---|
region | регион, к которому относится счет |
company | компания, к которой относится счет |
user | пользователь, к которому относится счет |
Query параметр | Oписание |
|---|---|
filter[operation_type] | фильтрация по полю operation_type |
filter[status] | поиск счетов с указанным статусом. Возможные значения: 1,2,3,4,5,12,13,14 |
filter[rental_id] | поиск счетов, относящихся к аренде c указанным id |
filter[amount] | поиск счетов по указанной сумме |
URL-путь | Описание |
|---|---|
| получить всех пользователей |
| получить данные о пользователе с указанным id |
query параметр | описание |
|---|---|
filter[name] | Поиск пользователя по имени |
filter[username] | Поиск пользователя по номеру телефона |
filter[email] | поиск по e-mail |
URL-путь | Описание |
|---|---|
| Получить все ТС |
| Получить информацию об одном ТС с указанным id |
URL-путь | Описание |
|---|---|
| получить все регионы |
| получить данные об одном регионе с указанным id |
URL-путь | Описание |
|---|---|
| получить все регионы |
| получить данные об одном тарифе с указанным id |