API для работы с информацией из ЕГРП365
Если вы разработчик, и хотите встроить функциональность Egrp365 в свое приложение, можете использовать наше простое API. Описание минимальное, если что-то будет непонятно — пишите вопрос на mail@egrp365.ru.
Общее описание
1. АПИ находится по адресу https://egrp365.org/api/v2/
2. Доступные методы:
3. Параметры методов get* передаются методом GET, параметры методов post* -- методом POST
4. Кодировка — UTF-8
5. Ответы приходят в JSON
6. Обязательно указывать User-Agent
7. Ваш ключ пользователя можете получить у нас по запросу, с описанием своего приложения.
Описание методов
Возвращает список доступных для заказа документов.
GET-Параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
Вернёт массив документов, например
{"22":{"id":22,"title":"Отчет об объекте недвижимости","cost":390,"time":"4-34 часа","type":"electronic"},"23":{"id":23,"title":"Отчет о переходе прав","cost":390,"time":"4-24 часа","type":"electronic"},"29":{"id":29,"title":"Уведомление об отсутствии перехода прав","cost":289,"time":"5-30 минут","type":"electronic"},"33":{"id":33,"title":"Отчет по объекту","cost":5990,"time":"1-3 рабочих дня","type":"electronic"},"47":{"id":47,"title":"Срочный отчет об объекте","cost":990,"time":"5-60 минут","type":"electronic"},"49":{"id":49,"title":"Срочный отчет о переходе прав","cost":990,"time":"5-45 минут","type":"electronic"}}
или пустой
[]
Параметры:
id - id документа
title - название документа
cost - стоимость документа
time - примерное время исполения
type - тип (electronic или paper)
В случае неудачи, вернёт номер и текст ошибки, например
{"error":[0,"Wrong api key"]}
Возвращает список объектов по указанному кадастровому/условному номеру.
GET-Параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
kadnum - (обязательный) кадастровый/условный номер формата
^([0-9\-\:\/\ \_\*]+)$
, например
39:03:010011:114
Вернёт массив объектов (не более 200), например
{"39:03:010011:114":{"objectId":"39:03:010011:114","kadNum":"39:03:010011:114","uslNum":"","address":" Россия, Калининградская обл., Гурьевский район, г. Гурьевск, ул. Безымянная, дом №3","reestr":2}}
или пустой
[]
Параметры:
objectid - id объекта
kadnum - кадастровый номер
uslnum - условный номер
address - адрес
В случае неудачи, вернёт номер и текст ошибки, например
{"error":[1,"kadnum has wrong format"]}
Возвращает список объектов по указанному адресу
GET-параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
region - (обязательно) регион страны
area - область
city - (обязательно) город
settlement - поселение
street - (обязательно) улица
house - (обязательно) номер дома
building - строение
apartment - квартира
fiasid - код объекта в ФИАС
reestr - выдавать записи только из конкретного реестра (1 - ГКН, 2 - ЕГРП)
Соответствия значениям из подсказок дадаты:
apartment - suggestion.data.flat
area - suggestion.data.area
building - suggestion.data.block
city - suggestion.data.city
house - suggestion.data.house
region - suggestion.data.region
street - suggestion.data.street
fiasid - suggestion.data.fias_id
Вернёт массив объектов, например
{"39:03:010011:114":{"objectId":"39:03:010011:114","kadNum":"39:03:010011:114","uslNum":"","address":" Россия, Калининградская обл., Гурьевский район, г. Гурьевск, ул. Безымянная, дом №3","reestr":2}}
или пустой
[]
Параметры ответа:
objectid - id объекта
kadnum - кадастровый номер
uslnum - условный номер
address - адрес
reestr - реестр (1 - ГКН, 2 - ЕГРП)
type - тип объекта (участок/здание/помещение/сооружение)
В случае неудачи, вернёт номер и текст ошибки, например
{"error":[1,"kadnum has wrong format"]}
Возвращает информацию по указанному id объекта.
Параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
objectid - (обязательный) id объекта, формат
^([0-9\-\:\/\ \_\*]+)$
Вернёт описание, например
{"objectid":"10:1:10138:40","kadnum":"10:01:0010138:40","uslnum":null,"address":"Республика Карелия, г. Петрозаводск, ул. Герцена, д. 35","altaddress":"г Петрозаводск, ул Герцена, д. 35","apartment":null,"brkstatus":0,"formrights":0,"name":"Офис","reestr":1,"area":null,"cost":null,"floor":null,"material":null,"year":null,"status":null,"objecttype":5,"order_options":[{"docid":22,"is_enabled":true,"example":"","description":"ФИО собственников (если есть), кадастровая стоимость, наличие\/отсутствие обременений\/аренды\/ипотеки","doctitle":"Отчет об объекте недвижимости","cost":390,"time":"4-34 часа"},{"docid":23,"is_enabled":true,"example":"","description":"История собственников (если есть) по сделкам, совершенным с 1998 года.","doctitle":"Отчет о переходе прав","cost":390,"time":"4-24 часа"},{"docid":44,"is_enabled":true,"example":"","description":"В рабочее время вам позвонит кадастровый инженер","doctitle":"Кадастровая консультация","cost":590,"time":" "}]}
Параметры ответа:
objectid - id объекта
kadnum - кадастровый номер
uslnum - условный номер
address - адрес
altaddress - альтернативное написание адреса
reestr - реестр (1 - ГКН, 2 - ЕГРП)
objecttype - тип объекта (0 - квартира/помещение, 1 - здание, 2 - участок, 3 - сооружение, 4 - объект незавершенного строительства, 5 - прочее)
name - описание объекта
area - площадь в кв.м., формат
float
cost - кадастровая стоимость в рублях, формат
float
floor - массив об этажности для зданий и квартир (type - Этаж/Этажность, value - цифра
int
)
material - материал стен
year - год постройки,
int
order_options - массив опций для заказа:
docid - id документа
is_enabled - доступен для заказа, true/false
example - ссылка на образец
В случае отсутствия параметр равен null
.
В случае неудачи, вернёт номер и текст ошибки, например {"error":[1,"objectid has wrong format"]}
Отправляет запрос на получение документов по указанному объекту, возвращает номер заказа и ссылку на оплату.
POST-параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
kadnum - (обязательный) кадастровый или условный номер объекта, формат ^([0-9\-\:\/\ \_\*]+)$
objectid - (обязательный) id объекта, формат ^([0-9\-\:\/\ \_\*]+)$
order_docs[] - (обязательный) массив id запрошенных документов (из доступных в методе getDocs для заказа), формат int
email - (обязательный) email заказчика, формат email
phone - мобильный телефон заказчика для СМС-уведомлений, формат 79114022068
Вернёт id заказа и ссылку на оплату, например
{"orderid":15574,"status":"создан","url":"https:\/\/egrp365.ru\/pay.php?oid=15574&email=mail%2B2%40egrp365.ru"}
Параметры ответа:
orderid - id заказа
status - статус заказа
summ - сумма заказа
url - ссылка на оплату заказа
В случае неудачи, вернёт номер и текст ошибки, например {"error":[1,"orderid has wrong format"]}
Возвращает статусы по каждому документу указанного заказа.
GET-параметры:
apiKey - (обязательный) индивидуальный ключ пользователя (выдается по запросу)
orderid - (обязательный) id заказа, формат int
email - (обязательный) email заказчика, формат email
Вернёт статус каждого документа в заказе, например
{"orderid ":15557,"documents":{"document":"Кадастровый паспорт","status":"отправлен","senddate":"2016-09-03 23:54:45","url":"https:\/\/egrp365.ru\/files-pdf\/pdfp\/80-3636241.pdf","zip":"https:\/\/egrp365.ru\/files\/zip\/Response-80-3636241.zip"}}
Параметры ответа:
orderid - id заказа
order_status - статус заказа
order_date - дата создания заказа
cost - сумма заказа
documents - массив документов в заказе
document - тип документа
status - статус документа
senddate - дата отправки (или null, если не был отправлен)
url - ссылка на готовый pdf-файл (или null, если файл не готов)
zip - ссылка на исходный xml-файл в zip-архиве (или null, если файл не готов)
В случае неудачи, вернёт номер и текст ошибки, например {"error":[1,"order not found"]}