Знакомство с API Rosreestr.net
В данном руководстве Вы найдете базовую информацию о принципах работы API Rosreestr и о подготовке к его использованию.

API (англ. Application Programming Interface) — это интерфейс программирования приложений. API Rosreest предоставляет набор готовых процедур, функций и структур, с помощью которых Вы можете создавать свои программы, приложения и скрипты для работы с сервисом.
Методы и объекты
API Rosreest — это интерфейс, позволяющий получать информацию из базы, которая хранится на серверах rosreestr.net с помощью http-запросов. Вам не нужно знать в подробностях, как устроена данная база, из каких таблиц и полей она состоит — достаточно того, что API-запрос об этом "знает". Тип возвращаемых данных и синтаксис запросов определены на стороне самого сервиса.

Например, для получения данных об объекте с кадастровым номером 39:15:121305:83 необходимо составить запрос такого вида:
https://rosreestr.net/api/method/database.get?egrn=39:15:121305:83&access_token={КЛЮЧ}&v=1.0
Рассмотрим отдельно все его составляющие:
  • https:// — протокол соединения.
  • rosreestr.net/api/method — адрес API-сервиса.
  • database.get — название метода API Rosreestr. Методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление. Например, database.get — метод для получения информации о кадастровом объекте, order.create — метод для создания заказа на получение выписок.

    Все методы разделены на секции. Например, для работы с кадастровыми объектами Вам нужны методы секции database, для работы с личной информацией — account, и так далее. Полный список методов по секциям доступен на этой странице.
  • ?egrn=39:15:121305:83&access_token={КЛЮЧ}&v=1.0 — параметры запроса. После названия метода и формата данных, необходимо передать его входные данные (если они есть) — как обычные GET или POST-параметры в http-запросе. В нашем примере мы сообщаем серверу, что хотим получить данные о кадастровом объекте с ЕГРН 39:15:121305:83 и формат этих данных должен соответствовать версии API 1.0. Входные параметры всегда перечислены на странице с описанием метода. Так же в каждом запросе к API Rosreestr должен присутствовать параметр access_token. Это Ваш личный ключ доступа к API.
    О том, где и как его получить читайте тут

В данном запросе сервер вернет ответ в виде JSON-объекта с запрошенными данными (или сообщение об ошибке, если что-то пошло не так). JSON — это формат записи данных в виде пар "имя параметра": "значение". Если Вы раньше не встречались с данным форматом, то мы рекомендуем познакомиться с ним, прежде чем продолжить чтение: Что такое JSON формат
Ключ доступа
Rosreestr.net - сервис, который предоставляет как общую информацию для всех пользователей, так и индивидуальную для конкретного пользователя. В Личном кабинете пользователь может просматривать статусы своих заказов, пополнять баланс личного кабинета и скачивать предоставленные ему файлы. Личный кабинет помогает разграничивать доступ к заказам и персональной информации.

В API этот принцип сохраняется. Если Вы запросите информацию по номеру заказа, не принадлежащего Вам, то API вместо ответа выдаст ошибку на такой запрос. Поэтому все методы требуют авторизации пользователя перед началом работы. Проще говоря, сервер должен знать, кто к нему обращается за информацией, чтобы предоставить ее в том же виде, что и в основной версии сайта.

Для идентификации в API используется специальный ключ доступа, который называется access_token. Ключ доступа — это строка из цифр, дефисов и латинских букв, которую Вы передаете на сервер вместе с запросом. Из этой строки сервер получает всю нужную ему информацию. Подробнее о том, как можно получить ключ доступа Вы можете прочитать здесь.

Ключ доступа может выглядеть, например, так:
47a59bc-6d272a0e620f6-c25ceab910e14-610f1-10f1-f6d

Access_token — это Ваш ключ доступа. При выполнении определенных условий человек, получивший Ваш ключ, может нанести существенный ущерб Вашим данным. Поэтому очень важно не передавать свой access_token третьим лицам.

После того, как Вы получите ключ доступа, Вы можете сделать вызов метода от своего имени. Например, получить список со всеми Вашими заказами. Для этого введите в адресную строку:
https://rosreestr.net/api/method/order.list?v=1.0&access_token=
и вставьте после знака "=" Ваш access_token, затем нажмите Enter. В ответе сервер вернет список идентификаторов всех ваших заказов.

Подробное руководство о получении ключей доступа находится на этой странице.
Ограничение запросов и права доступа
Как Вы уже знаете, все методы делятся на секции — account, database, order и т.д. Каждая секция соответствует определенному разделу на сайте. Часто приложения создаются для работы с конкретным разделом. Например, только для просмотра информации, а не для заказа выписок. Так же Вы можете создать ключ с ограниченными правами доступа и дать его фрилансеру для разработки или тестирования приложения.

Поэтому в API права доступа ключей разграничены, как и методы.

Управление правами доступа access_token осуществляется через личный кабинет сайта. Вы всегда можете проверить разрешённые права для данного ключа с помощью метода account.getPermissions.

Так же, для защиты своего ключа можно ограничить доступ данного access_token к API с определённого IP адреса. Сделать это можно через личный кабинет.
Что дальше?
Дальше все зависит лишь от Вашего желания и вдохновения.

На практике никто не работает с API из соседней вкладки браузера. Для этого используют разные языки программирования, SDK, генераторы кода и т.д. Сам механизм работы с API весьма прост, средства для отправки http-запросов и обработки ответа от сервера предусмотрены практически в любой среде разработки: а это значит, что возможность выбора есть всегда.
Рекомендации, которые могут Вам помочь найти любой, даже самый сложный объект:
  • если Вы ищете дачный участок, то введите его наименование в окне "улица" не используя кавычек (например, Рыбачий-12);
  • номер участка СНТ вставляйте в окно "квартира" или "корпус";
  • сделайте поиск более обширным: сам населённый пункт не стоит указывать;
  • внесите информацию об улице, номере дома, корпуса и квартиры (если есть);
  • не используйте букву "Ё". Вместо неё попробуйте написать букву "Е";
  • в сложных названиях, особенно когда улица названа в честь кого-то, используйте ключевые слова, например: улица Фридриха Энгельса - напечатайте просто Фридриха.

Вернуться к поиску >