B2BH2H

Получение списка объектов строительства застройщика

Пром GET https://baas.alfabank.ru/api/build-projects

Песочница GET https://sandbox.alfabank.ru/api/build-projects

Scope

escrow

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

HEADERS
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

Пример запроса
curl -X GET https://baas.alfabank.ru/api/build-projects \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
 [
  {
    "buildingPermitNumber": "61-310-998601-2022",
    "regionCode": "054",
    "projectNumber": "162",
    "settlement": "Новосибирск",
    "commercialName": "ЖК ЗАПАДНЫЕ АЛЛЕИ",
    "city": "Новосибирск",
    "area": "ОКТЯБРЬСКИЙ",
    "country": "RU",
    "buildingPermitDate": "2021-10-01",
    "phases": [
      {
        "index": 1,
        "name": "поз. 4.1 - 9-этажный 4-х секц дом",
        "street": "11-4 на земельном участке с к.н. 61:44:0073012:390",
        "house": "4.1",
        "building": "2",
        "termEscrowOrder": "2022-03-22"
      }
     ]
   }
]

buildingPermitNumber
stringoptional

Номер РНС

regionCode
stringoptional

Код региона

projectNumber
stringoptional

Номер проекта строительства

settlement
stringoptional

Наименование населенного пункта

commercialName
stringoptional

Коммерческое обозначение объекта

city
stringoptional

Город

area
stringoptional

Наименование района

country
stringoptional

Код страны

buildingPermitDate
stringoptional

Дата РНС

array of objectoptional

Этапы строительства

index
integeroptional

Порядковый номер этапа строительства в пределах проекта

name
stringoptional

Краткое наименование этапа строительства

street
stringoptional

Улица объекта недвижимости

house
stringoptional

Номер дома объекта строительства

building
stringoptional

Номер строения/корпуса

termEscrowOrder
stringoptional

Срок условного депонирования

Пример ответа 200 (ОК)
 [
  {
    "buildingPermitNumber": "61-310-998601-2022",
    "regionCode": "054",
    "projectNumber": "162",
    "settlement": "Новосибирск",
    "commercialName": "ЖК ЗАПАДНЫЕ АЛЛЕИ",
    "city": "Новосибирск",
    "area": "ОКТЯБРЬСКИЙ",
    "country": "RU",
    "buildingPermitDate": "2021-10-01",
    "phases": [
      {
        "index": 1,
        "name": "поз. 4.1 - 9-этажный 4-х секц дом",
        "street": "11-4 на земельном участке с к.н. 61:44:0073012:390",
        "house": "4.1",
        "building": "2",
        "termEscrowOrder": "2022-03-22"
      }
     ]
   }
]

error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - Доступ к счету запрещен

error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.