Базовый адрес: https://api.cadastre.ru/v1/
Конечные точки:
Имя | Описание |
---|---|
GET /definitions | Получить список терминов |
GET /definitions/ID | Получить термин |
GET /news | Получить список новостей |
GET /news/ID | Получить новость |
Параметр | Описание |
---|---|
escapeUnicode |
Необязательный параметр 1 или 0 (по умолчанию 1) При указании 0 возвращаемые многобайтовые символы Unicode не будут кодированы. |
Ответ с соответствующим статусом (200, 400, 401, 404, 500) возвращается в формате JSON:
{
"request": {
"version": [Версия API],
"resource": [Запрошенный ресурс],
"resourceId": [Запрошенный идентификатор ресурса],
"method": [HTTP-метод],
"parameters": [Распознанные параметры],
"userAuthKeyId": [Идентификатор ключа]
},
"error": [Описание ошибки при наличии],
"data": [Ответ]
}
Параметр | Описание |
---|---|
request.userAuthKeyId | При успешной авторизации выводится внутренний идентификатор персонального ключа доступа, иначе NULL |
error | Текстовое описание ошибки. При удачном ответе выводится NULL |
Конечные точки: GET /definitions, GET /definitions/ID
Параметр | Описание |
---|---|
updatedAfter |
Необязательный параметр Формат Date «YYYY-MM-DD» или DateTime «YYYY-MM-DD hh:mm:ss» При указании будут возвращены только термины, созданные или измененные после этой отметки времени. |
При запросе обновлений следует указывать параметр «updatedAfter», равный максимальному значению параметра «updated» у полученных ранее терминов.
В параметре ответа «data» будет выведено:
[{
"id": [Идентификатор термина],
"type": 'definition',
"title": [Наименование термина],
"annotation": [Простая текстовая аннотация],
"text": [Текст определения в формате HTML],
"updated": [Метка времени последнего обновления (UTC+3)],
"articleId": [Идентификатор статьи],
"articleTitle": [Наименование статьи],
"url": [URL соответствующего параграфа в справочнике],
"isSubscriptionRequired": [Требуется ли подписка для доступа к статье],
"image": [URL иллюстрации],
"thumbnail": [URL миниатюры иллюстрации]
}]
Параметр | Описание |
---|---|
image | Иллюстрация есть только у некоторых изображений. При отсутствии выводится NULL |
thumbnail | Миниатюра имеется только у больших изображений. При отсутствии выводится NULL |
text | Текст выводится только при запросе отдельного термина (GET definitions/ID). В текстах есть ссылки на другие термины в виде идентификатора в квадратных скобках. Их можно убрать или заменить на активные ссылки регулярными выражениями, например: |
text = text.replace(/\[([а-яА-Я0-9ёЁa-zA-Z .\-\(\)]+) (\d+)\]/g, '<span class="paragraphLink" paragraphId="$2">$1</span>');
text = text.replace(/\[(\d+)\]/g, '<span class="paragraphLink" paragraphId="$1">[$1]</span> ');
Конечные точки: GET /news, GET /news/ID
Параметр | Описание |
---|---|
updatedAfter |
Необязательный параметр Формат Date «YYYY-MM-DD» или DateTime «YYYY-MM-DD hh:mm:ss» При указании будут возвращены только новости, созданные или измененные после этой отметки времени. |
createdAfter |
Необязательный параметр Формат Date «YYYY-MM-DD» При указании будут возвращены только новости, созданные после этой отметки времени. |
При запросе обновлений следует указывать параметр «updatedAfter», равный максимальному значению параметра «updated» у полученных ранее новостей.
В параметре ответа «data» будет выведено:
[{
"id": [Идентификатор новости],
"type": 'news',
"title": [Заголовок],
"annotation": [Простая текстовая аннотация],
"text": [Текст новости в формате HTML],
"date": [Дата создания (UTC+3)],
"updated": [Метка времени последнего обновления (UTC+3)],
"color": [Цвет, близкий к цветовой гамме иллюстрации],
"url": [URL новости в справочнике],
"originalUrl": [URL новости в журнале «Учет недвижимости»],
"image": [URL иллюстрации],
"thumbnail": [URL миниатюры иллюстрации]
}]
Параметр | Описание |
---|---|
text | Текст выводится только при запросе отдельной новости (GET definitions/ID) |
Полученные по API данные могут быть использованы как разъясняющие сопровождающие или исходные материалы в указанных при получении ключа доступа коммерческих или некоммерческих информационных системах (включая приложения), производных материалах.
Полученные данные об отдельных сущностях (отдельная новость, отдельные термин) не должны храниться в информационной системе дольше текущей сессии пользователя.
Отображаемые полученные или производные данные должны сопровождаться активной ссылкой «Справочник кадастрового инженера Cadastre.ru».
Персональный ключ (токен) необходимо передать в поле «Authorization» в заголовке запроса.
Для получения ключа доступа обратитесь на api@cadastre.ru
В зависимости от проекта доступ может быть платным на договорной основе или бесплатным.
curl -X GET https://api.cadastre.ru/v1/definitions?updatedAfter=2022-08-21%2002:22:24 -H "Authorization: YOUR_AUTH_CODE"
var url = "https://api.cadastre.ru/v1/definitions?updatedAfter=2022-08-21%2002:22:24";
var xhr = new XMLHttpRequest();
xhr.open("GET", url);
xhr.setRequestHeader("Authorization", "YOUR_AUTH_CODE");
xhr.onreadystatechange = function () {
if (xhr.readyState === 4) {
console.log(xhr.status);
console.log(xhr.responseText);
}};
xhr.send();
$url = "https://api.cadastre.ru/v1/definitions?updatedAfter=2022-08-21%2002:22:24";
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$headers = array(
"Authorization: YOUR_AUTH_CODE",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);
URL url = new URL("https://api.cadastre.ru/v1/definitions?updatedAfter=2022-08-21%2002:22:24");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "YOUR_AUTH_CODE");
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
var url = "https://api.cadastre.ru/v1/definitions?updatedAfter=2022-08-21%2002:22:24";
var httpRequest = (HttpWebRequest)WebRequest.Create(url);
httpRequest.Headers["Authorization"] = "YOUR_AUTH_CODE";
var httpResponse = (HttpWebResponse)httpRequest.GetResponse();
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
var result = streamReader.ReadToEnd();
}
Console.WriteLine(httpResponse.StatusCode);