API - Конвертации выписок

AUTH Token

Руководстве по использованию API

  • Метод: POST
  • Ссылка: https://govxml.ru/api/v1/converter/transform
  • Формат POST данных: multipart/form-data
  • Авторизация через HTTP заголовок: Authorization: Bearer auth_token
  • Авторизация через POST параметр: access_token=auth_token

Поля запроса

Название Тип Значение Пример Пояснение
file bynary/text - file=@file.zip Обязательное поле. Файл xml выписки в формате .zip, .xml
is_html bool true, false is_html=true получить html выписку
is_pdf bool true, false is_pdf=true получить pdf выписку
document string extract - выписка, report - отчёт document=extract Выбор шаблона для выписки.

Выписка - формируется согласно шаблонам предоставляемые Росреестром

Отчёт - формируется с учётом статьи 62 218-ФЗ пунктом 27 и носит информационный характер

geo_point string auto - авто, disallowed - вырезать, allowed - оставить geo_point=auto

Для xml файлов более 1Мб автоматически вырезаются гео точки.

Для больших выписок желательно вырезать точки, что бы было возможно открыть выписку.

pdf[orientation] string auto - авто, book - книжная, landscape - альбомная pdf[orientation]=book Ориентация для pdf версии

Авто - выписки о переходе прав преобразуются в книжную, все остальные в альбомную

pdf[marginLeft]=10 float - pdf[marginLeft]=10 Левый отступ для PDF (в мм)
pdf[marginRight]=10 float - pdf[marginRight]=10 Правый отступ для PDF (в мм)
pdf[marginTop]=10 float - pdf[marginTop]=10 Верхний отступ для PDF (в мм)
pdf[marginBottom]=10 float - pdf[marginBottom]=10 Нижний отступ для PDF (в мм)

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

                        
$headers = [
    'Authorization: Bearer auth_token',
];
$post = [];
$post['file'] = "@80-241201227.zip";
$post['is_html'] = 'true';
$post['is_pdf'] = 'true';
$post['pdf[marginLeft]'] = 0.4;
$post['pdf[marginRight]'] = 0.4;
$post['pdf[marginTop]'] = 0.4;
$post['pdf[marginBottom]'] = 0.4;
$post['pdf[orientation]'] = "auto";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://govxml.ru/api/v1/converter/transform");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);

$response = curl_exec( $ch );
print_r($response);
                        
                        
                            
$ curl https://govxml.ru/api/v1/converter/transform \
    -H "Authorization: Bearer auth_token" \
    -F "file=@80-241201227.zip" \
    -F "is_html=true" \
    -F "is_pdf=true" \
    -F 'pdf[marginLeft]=0.4' \
    -F 'pdf[marginRight]=0.4' \
    -F 'pdf[marginTop]=0.4' \
    -F 'pdf[marginBottom]=0.4' \
    -F "pdf[orientation]=auto"
                            
                        

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

                        
{
    "id": "VzJSs5_80-241201227",
    "contents": {
        "html": {
            "url": "https://govxml.ru/api/v1/converter/download/VzJSs5_80-241201227/govxml.ru__80-241201227.html",
            "size": 40714
        },
        "pdf": {
            "url": "https://govxml.ru/api/v1/converter/download/VzJSs5_80-241201227/govxml.ru__80-241201227.pdf",
            "size": 213246
        },
        "xml": {
            "url": "https://govxml.ru/api/v1/converter/download/VzJSs5_80-241201227/govxml.ru__80-241201227.xml",
            "size": 6684
        }
    },
    "header": {
        "style_tags": {
            "system": "EGRP",
            "name": "Reestr_Extract_Big",
            "sub_name": "ROOM",
            "version": "07"
        },
        "style_sheet": "https://portal.rosreestr.ru/xsl/EGRP/Reestr_Extract_Big/ROOM/07/Common.xsl",
        "first_tag": "kpoks",
        "title": "Выписка из ЕГРН об объекте недвижимости"
    },
    "fields": {
        "cadastral_number": "77:05:***:***",
        "cadastral_cost": "5417215.51",
        "type": "Об объекте недвижимости",
        "address": "Москва, ул Кошкина, д 17, кв ***",
        "encumbrance": [
            {
                "owner": "Банк ВТБ (Публичное Акционерное Общество), ИНН: 7702070139",
                "type": "Ипотека",
                "number": "77:05:***:***-77/055/2021-4",
                "term": "242 месяца с даты фактического предоставления кредита",
                "start_date": "29.01.2021",
                "end_date": "",
                "period": "1 год, 7 месяцев"
            }
        ],
        "owners": [
            {
                "owner": "Иванов Иван Иванович",
                "rights": "Собственность, № 77-77-***/***/***-729 от 25.06.2014",
                "rights_date": "25.06.2014",
                "rights_period": "8 лет, 2 месяца"
            }
        ],
        "more": [
            {
                "key": "Дата присвоения кадастрового номера",
                "value": "2012-05-26"
            },
            {
                "key": "Площадь",
                "value": "40.8"
            }
        ]
    }
}