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

Содержание

• 1. Аутентификация
• 2. Ограничения скорости
• 3. Безопасность
• 4. Обработка ошибок
• 5. Объявления
• 5.1 Поиск объявлений
• 5.2 Создание нового объявления
• 5.3 Просмотр объявления

1. Аутентификация

Для доступа к защищенным данным используйте токен авторизации в заголовке:

Authorization: Bearer YOUR_API_TOKEN
Content-Type: multipart/form-data

• Токен: Получите токен в личном кабинете на странице: https://dvaugla.ru/user/api-tokens
• Тип: Используется Laravel Sanctum.

2. Ограничения скорости

Максимальное количество запросов в минуту: 20.

3. Безопасность

• Используйте HTTPS для всех запросов.
• Токены хранятся в зашифрованном виде.

4. Обработка ошибок

Примеры ответов

{
    "success": false,
    "message": "Токен отсутствует или недействителен",
    "error": "Unauthenticated"
}

{
    "success": false,
    "message": "Нет прав на доступ к ресурсу",
    "error": "Forbidden"
}

{
    "success": false,
    "message": "Объект не найден",
    "error": "Record not found"
}

{
    "success": false,
    "message": "Ошибка валидации данных",
    "errors": {
        "title": ["Поле обязательно для заполнения"],
        "price": ["Цена должна быть числом"]
    },
    "error": "Unprocessable Entity"
}

{
    "success": false,
    "message": "Превышен лимит запросов. Повторите через 10 секунд",
    "error": "Too Many Requests"
}

{
    "success": false,
    "message": "Произошла ошибка сервера",
    "error": "Internal Server Error"
}

5.1 Поиск объявлений

Возвращает список всех объектов недвижимости с возможностью фильтрации и пагинации.

Параметры запроса

Пример запроса с дополнительными полями

http://127.0.0.1:8000/api/v1/ads?page=1&per_page=5&user_id=my_id,555&material=Монолитный&state=Черновик,Активное&type=Дом,Квартира&tariff=Бесплатный,Премиум&action=Продать,Сдать&period=за всё,за час&min_price=400&max_price=40000000&min_floor=5&max_floor=40&min_total_area=1&max_total_area=100&sort=tariff&order=asc

Параметры ответа

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

{
    "success": true,
    "data": [
        {
            "id": "5351020320056653",
            "type": "Квартира",
            "action": "Купить",
            "material": "Монолитный",
            "price": 10000000,
            "period": "за всё",
            "tariff": "Премиум",
            "floor": 5,
            "floors": 10,
            "total_area": 50.25,
            "state": "Активное",
            "description": "Пример описания, указывается тут."
        },
        {
            "id": "9564625179668665",
            "type": "Квартира",
            "action": "Купить",
            "material": "Монолитный",
            "price": 10000000,
            "period": "за всё",
            "tariff": "Премиум",
            "floor": 5,
            "floors": 10,
            "total_area": 50.25,
            "state": "Активное",
            "description": "Пример описания, указывается тут."
        }
    ],
    "meta": {
        "total": 2,
        "per_page": 5,
        "current_page": 1,
        "last_page": 1
    }
}

5.2 Создание нового объявления

Создает новое объявление о недвижимости.

Параметры запроса

Параметры ответа

Если создание объявления было успешно в ответе в заголовок добавляется поле: Location с URL новой записи

Location: https://dvaugla.ru/api/v1/ads/{id}

https://dvaugla.ru/api/v1/ads
{
    "latitude": 55.836773,
    "longitude": 37.491909,
    "total_area": 50.25,
    "price": 10000000,
    "tariff": "Премиум",
    "days": "60",
    "bid": 17.10
}

{
    "success": true,
    "data": {
        "id": "8426893080997327",
        "type": "Квартира",
        "action": "Продать",
        "apartment": "не указано",
        "room": "не указано",
        "latitude": 55.836773,
        "longitude": 37.491909,
        "country": "Россия",
        "postal": "125212",
        "city": "г Москва",
        "street": "ул Адмирала Макарова",
        "house": "д 6А",
        "block": "к 1",
        "flat": null,
        "owner": "Собственник",
        "owner_more": null,
        "srok": "не указано",
        "ready": "2025-06-16",
        "year": null,
        "material": "не указано",
        "material_more": null,
        "floor": null,
        "floors": null,
        "elevator": "не указано",
        "elevator_more": null,
        "infra": [],
        "total_area": 50.25,
        "living_area": null,
        "kitchen_area": null,
        "height": null,
        "remont": "не указано",
        "remont_more": null,
        "bathroom": "не указано",
        "bathroom_more": null,
        "balkon": "не указано",
        "balkon_more": null,
        "power": "не указано",
        "price": 10000000,
        "period": "за всё",
        "commission": "нет комиссии",
        "commission_more": null,
        "by_email": false,
        "contact_email": null,
        "by_phone": false,
        "contact_phone": null,
        "tariff": "Премиум",
        "description": null,
        "htmlurl": null,
        "photo": [],
        "state": "Активное",
        "days": 60,
        "bid": 17.10,
        "cost": 1026,
        "order_url": "https://yoomoney.ru/checkout/payments/v2/contract?orderId=2ff1eb24-000f-5000-8000-10d828688f8e",
        "order_expired": "2025-06-18T16:31:49+03:00"
        "created_at": "2025-06-17T16:31:49+03:00"
    }
}

https://dvaugla.ru/api/v1/ads
{
    "type": "Квартира",
    "action": "Продать",
    "apartment": "Квартира",
    "room": "1",
    "latitude": 55.836773,
    "longitude": 37.491909,
    "country": "Россия",
    "postal": "125212",
    "city": "г Москва",
    "street": "ул Адмирала Макарова",
    "house": "д 6А",
    "block": "к 1",
    "flat": "кв 349",
    "owner": "другой",
    "owner_more": "Сосед",
    "srok": "меньше 1 года",
    "ready": "2025-06-01",
    "year": "2020",
    "material": "другой",
    "material_more": "Сено",
    "floor": "5",
    "floors": "10",
    "elevator": "присутствует",
    "elevator_more": "4",
    "infra[]": "Поликлиника",
    "infra[]": "Школа",
    "total_area": 50.25,
    "living_area": "30.5",
    "kitchen_area": "10.47",
    "height": "3",
    "remont": "другой",
    "remont_more": "так себе",
    "bathroom": "другой",
    "bathroom_more": "отсутствует",
    "balkon": "другой",
    "balkon_more": "переделан в комнату",
    "power": "A",
    "price": 10000000,
    "period": "за всё",
    "commission": "% от стоимости",
    "commission_more": "5",
    "by_email": "1",
    "contact_email": "test@yandex.ru",
    "by_phone": "1",
    "contact_phone": "+79688668860",
    "tariff": "Премиум",
    "description": "Пример описания, указывается тут.",
    "htmlurl": "https://dvaugla.ru",
    "photo[]": "foto1.png",
    "photo[]": "foto2.jpg",
    "state": "Активное",
    "days": "60",
    "bid": 18
}

{
    "success": true,
    "data": {
        "id": "2010707773194533",
        "type": "Квартира",
        "action": "Продать",
        "apartment": "Квартира",
        "room": "1",
        "latitude": 55.836773,
        "longitude": 37.491909,
        "country": "Россия",
        "postal": "125212",
        "city": "г Москва",
        "street": "ул Адмирала Макарова",
        "house": "д 6А",
        "block": "к 1",
        "flat": "кв 349",
        "owner": "другой",
        "owner_more": "не указано",
        "srok": "меньше 1 года",
        "ready": "2025-06-01",
        "year": "2020",
        "material": "другой",
        "material_more": "Сено",
        "floor": "5",
        "floors": "10",
        "elevator": "присутствует",
        "elevator_more": 4,
        "infra": [
            "Поликлиника",
            "Школа"
        ],
        "total_area": 50.25,
        "living_area": "30.5",
        "kitchen_area": "10.47",
        "height": "3",
        "remont": "другой",
        "remont_more": "так себе",
        "bathroom": "другой",
        "bathroom_more": "отсутствует",
        "balkon": "другой",
        "balkon_more": "переделан в комнату",
        "power": "A",
        "price": 10000000,
        "period": "за всё",
        "commission": "% от стоимости",
        "commission_more": "5",
        "by_email": true,
        "contact_email": "test@yandex.ru",
        "by_phone": true,
        "contact_phone": "+79688668860",
        "tariff": "Премиум",
        "description": "Пример описания, указывается тут.",
        "htmlurl": "https://dvaugla.ru",
        "photo": [
            "ad-images/6854157d72a191160048371456165.png",
            "ad-images/6854157ea9ce31160048371456165.png"
        ],
        "state": "Активное",
        "days": 60,
        "bid": 18,
        "cost": 1080,
        "order_url": "https://yoomoney.ru/checkout/payments/v2/contract?orderId=2ff1eb24-000f-5000-8000-10d828688f8e",
        "order_expired": "2025-06-18T16:29:43+03:00"
        "created_at": "2025-06-17T16:29:43+03:00"
    }
}

5.3 Просмотр объекта

Возвращает информацию по указанному объекту.

Параметры запроса

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

https://dvaugla.ru/api/v1/ads/9373075910006562
                    

Пример запроса с дополнительными полями

https://dvaugla.ru/api/v1/ads/9373075910006562?format=short
                    

Пример запроса с дополнительными полями

https://dvaugla.ru/api/v1/ads/9373075910006562?format=full&with=photo,user
                    

Параметры ответа

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

{
    "success": true,
    "data": {
        "id": "7966356998567196",
        "type": "Квартира",
        "action": "Продать",
        "apartment": "Квартира",
        "room": "1",
        "latitude": "55.836773000",
        "longitude": "37.491909000",
        "country": "Россия",
        "postal": "125212",
        "city": "г Москва",
        "street": "ул Адмирала Макарова",
        "house": "д 6А",
        "block": "к 1",
        "flat": "кв 349",
        "owner": "другой",
        "owner_more": "Сосед",
        "srok": "меньше 1 года",
        "ready": "2025-06-01",
        "year": "2020",
        "material": "другой",
        "material_more": "Сено",
        "floor": 5,
        "floors": 10,
        "elevator": "присутствует",
        "elevator_more": 4,
        "infra": [
            "Школа",
            "Поликлиника"
        ],
        "total_area": 50.25,
        "living_area": "30.50",
        "kitchen_area": "10.47",
        "height": "3.00",
        "remont": "другой",
        "remont_more": "так себе",
        "bathroom": "другой",
        "bathroom_more": "отсутствует",
        "balkon": "другой",
        "balkon_more": "переделан в комнату",
        "power": "A",
        "price": 10000000,
        "period": "за всё",
        "commission_more": 5,
        "commission": "% от стоимости",
        "by_email": true,
        "contact_email": "test@yandex.ru",
        "by_phone": true,
        "contact_phone": "+79688668863",
        "tariff": "Премиум",
        "description": "Пример описания, указывается тут.",
        "htmlurl": "https://dvaugla.ru",
        "photo": [
            "http://127.0.0.1:8000/storage/ad-images/686ab7c50b7967966356998567196.png"
        ],
        "state": "Активное",
        "rating": 0,
        "created_at": "2025-07-06T20:52:04+03:00",
        "stoped_at": "2025-08-06T20:52:04+03:00",
        "user": {
            "id": "7247191241678337",
            "name": "Алексей",
            "rating": 0,
            "rating_count": 0
        }
    }
}