КЛАДР в облаке

Простой и удобный сервиc для работы с базой адресов

Интеграция

Возможности

Сервис предоставляет он-лайн интерфейс к базе адресов Российской Федерации(«ФИАС»). Обмен данными происходит в формате JSON, с поддержкой JSONP.

Для облегчнения интеграции разработаны плагины под разные плаформы, которые подробно описаны ниже на этой странице. Плагины распространяются бесплатно под лицензией «Public domain», без каких-либо ограничений на использование.

Основные возможности:

  • Искать регионы, нас. пункты, улицы, дома по подстроке и по коду
  • Фильтровать данные по регионам, нас. пунткам и улицам
  • Получать сведения о родительских элементах и почтовых индексах

Например, можно попросить сервис вернуть все города на букву «А», или все улицы Москвы начинающиеся на «Лен».

Исходные коды

Все исходные коды сервиса доступны в открытом виде. Вы можете принять участие в разработке проекта.

А у кого можно спросить?

Напишите нам на info@kladr-api.ru.

Документация API сервиса

Документация API сервиса


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

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

Адрес страницы для запроса: http://kladr-api.ru/api.php

Адрес страницы для запроса платных токенов: http://kladr-api.com/api.php

Список доступных параметров запроса:
  • token — (необязательно) Токен для доступа к сервису. Используется только для доступа к платным серверам
  • regionId — Код региона (области)
  • districtId — Код района
  • cityId — Код города (населённого пункта)
  • streetId — Код улицы
  • buildingId — Код дома (строения)
  • query — Строка для поиска по названию
  • contentType — Тип возвращаемых объектов (region, district, city, street, building)
  • withParent — Если 1, сервис вернёт объекты вместе с родительскими (для района это регион, для населённого пункта район и регион и т.п.)
  • limit — Количество возвращаемых объектов
  • offset — Смещение в выдаче (для организации постраничного вывода)
  • typeCode — Тип объектов для выдачи:
    • 1 — города
    • 2 — поселки
    • 4 — деревни
    • Битовые комбинации, например, 3 ( 1 | 2 ) — города и поселки
  • zip — Почтовый индекс. Работает только при contentType = building. В этом случае можно не передать parentId. Поиск по почтовому индексу — это поиск по строениям (building), поэтому логично указать withParent = 1 и limit = 1, чтоб выбрать данные о регионе, нас. пункте и т.п.
    Например: http://kladr-api.ru/api.php?contentType=building&limit=1&withParent=1&zip=163000
  • oneString — Поиск адреса одной строкой в свободной форме. С этим параметром используются:
    • query — строка поиска
    • withParent=1 — выводить сведения о родителях
    • limit — кол-во результатов в выдаче
    • regionId, districtId, cityId — фильтры для ограничения поиск
    Например: http://kladr-api.ru/api.php?query=%D0%BC%D0%BE%D1%81%D0%BA%D0%B2%D0%B0&oneString=1&limit=1&withParent=1
  • callback – JavaScript метод которому будет передан ответ базы

Формат ответа сервиса

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

Запрос: http://kladr-api.ru/api.php?query=Арх&contentType=city&withParent=1&limit=2

Ответ:

{
    "searchContext": {                      // Объект с переданными серверу параметрами
        "query": "Арх",
        "contentType": "city",
        "withParent": 1,
        "limit": 2
    },
    "result": [                             // Массив полученных объектов заданного типа (населённые пункты)
        {
            "id": "2900000100000",          // Код объекта
            "name": "Архангельск",          // Название объекта
            "zip": null,                    // Почтовый индекс объекта
            "type": "Город",                // Тип объекта полностью
            "typeShort": "г",               // Тип объекта коротко
            "okato": "11401000000",         // Код ОКАТО
            "parents": [                    // Массив родительских объектов (если был передан параметр withParent)
                {
                    "id": "2900000000000",
                    "name": "Архангельская",
                    "zip": null,
                    "type": "Область",
                    "typeShort": "обл",
                    "okato": "11000000000",
		    "contentType": "region"
                }
            ]
        },
        {
            "id": "2800200000100",
            "name": "Архара",
            "zip": "676740",
            "type": "Поселок городского типа",
            "typeShort": "пгт",
            "okato": "10205551000",
            "parents": [
                {
                    "id": "2800000000000",
                    "name": "Амурская",
                    "zip": "675000",
                    "type": "Область",
                    "typeShort": "обл",
                    "okato": "10000000000",
		    "contentType": "region"
                },
                {
                    "id": "2800200000000",
                    "name": "Архаринский",
                    "zip": null,
                    "type": "Район",
                    "typeShort": "р-н",
                    "okato": "10205000000",
		    "contentType": "district"
                }
            ]
        }
    ]
}   
	    

Особенности поиска объектов

Поиск объектов осуществляется либо по названию либо по коду связанного (родительского либо дочернего элемента). Поиск объектов по названию осуществляется по шаблону /^название/ (т.е. выбираются объекты, название которых полностью совпадает с поисковой строкой либо начинается на неё).

Для поиска улицы по названию необходимо обязательно указать код населённого пункта, например cityId=7800000000000&query=3&contentType=street.
Для поиска строения по названию необходимо обязательно указать код улицы, например streetId=29000001000025800&query=1&contentType=building.

jQuery plugin

Амиро.CMS

Drupal

.NET provider

PHP API

Yii Framework

1С-Битрикс

1С-Битрикс (2)

Node.js

Java

1C Предприятие 8.2