Поиск по сайту

API
Главная / API - Подбор адресов

Подбор адресов

Обновлено 19.12.2019
121 кб

Общие сведения

Сервис позволяет получать "подсказки" адреса, т. е. варианты адресов на основании введенной части адреса, а также получать адреса в стандартизированном формате на основании введенных адресов.

Получение подсказок

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/suggest_address.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "query":"московский",
   "city_code":"7800000000000000000000000",
   "count":"10",
   "mode":"pretty"
}

Адрес метода: https://api.dellin.ru/v1/suggest_address.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <query>московский</query>
   <city_code>7800000000000000000000000</city_code>
   <count>10</count>
   <mode>pretty</mode>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDНетstringID сессии, требуется для учета индивидуальных скидок. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
queryДаstringСтрока для поиска подсказок
city_codeДаstring

Код КЛАДР населенного пункта. Может быть получен с помощью сервисов, представленных на странице "Использование кодов КЛАДР"

countНетinteger

Количество требуемых подсказок.

Доступные значения - от 1 до 20.

Значение по умолчанию - 20

modeНетstring

Формат возвращаемых данных.

Доступные значения:

  • raw - данные в неформатированном виде
  • pretty - форматированные данные

Значение по умолчанию - "pretty"

Ответ метода

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

{ 
   "suggestions":[ 
      { 
         "value":"г Санкт-Петербург, Московский пр-кт",
         "unrestricted_value":"г Санкт-Петербург, Московский пр-кт",
         "data":{ 
            "region_kladr_id":"7800000000000000000000000",
            "region_with_type":"г Санкт-Петербург",
            "region":"Санкт-Петербург",
            "area_fias_id":null,
            "area_kladr_id":null,
            "area_with_type":null,
            "area":null,
            "city_kladr_id":"7800000000000000000000000",
            "city_with_type":"г Санкт-Петербург",
            "city":"Санкт-Петербург",
            "city_area":null,
            "settlement_fias_id":null,
            "settlement_kladr_id":null,
            "settlement_with_type":null,
            "settlement":null,
            "street_kladr_id":"7800000000008520000000000",
            "street_with_type":"Московский пр-кт",
            "street":"Московский",
            "country":"Россия"
            }
    },
      { 
         "value":"г Санкт-Петербург, г Пушкин, Московский пер",
         "unrestricted_value":"г Санкт-Петербург, г Пушкин, Московский пер",
         "data":{ 
            "region_kladr_id":"7800000000000000000000000",
            "region_with_type":"г Санкт-Петербург",
            "region":"Санкт-Петербург",
            "area_fias_id":null,
            "area_kladr_id":null,
            "area_with_type":null,
            "area":null,
            "city_kladr_id":"7800000900000000000000000",
            "city_with_type":"г Пушкин",
            "city":"Пушкин",
            "settlement_fias_id":null,
            "settlement_kladr_id":null,
            "settlement_with_type":null,
            "settlement":null,
            "street_kladr_id":"7800000900000720000000000",
            "street_with_type":"Московский пер",
            "street":"Московский"       
         }
      }
    ]
}
<response>
   <suggestions>
      <value>г Санкт-Петербург, Московский пр-кт</value>
      <unrestricted_value>г Санкт-Петербург, Московский пр-кт</unrestricted_value>
      <data>
         <region_kladr_id>7800000000000000000000000</region_kladr_id>
         <region_with_type>г Санкт-Петербург</region_with_type>
         <region>Санкт-Петербург</region>
         <area_fias_id />
         <area_kladr_id />
         <area_with_type />
         <area />
         <city_kladr_id>7800000000000000000000000</city_kladr_id>
         <city_with_type>г Санкт-Петербург</city_with_type>
         <city>Санкт-Петербург</city>
         <city_area />
         <settlement_fias_id />
         <settlement_kladr_id />
         <settlement_with_type />
         <settlement />
         <street_kladr_id>7800000000008520000000000</street_kladr_id>
         <street_with_type>Московский пр-кт</street_with_type>
         <street>Московский</street>
         <country>Россия</country>
      </data>
   </suggestions>
   <suggestions>
      <value>г Санкт-Петербург, г Пушкин, Московский пер</value>
      <unrestricted_value>г Санкт-Петербург, г Пушкин, Московский пер</unrestricted_value>
      <data>
         <region_kladr_id>7800000000000000000000000</region_kladr_id>
         <region_with_type>г Санкт-Петербург</region_with_type>
         <region>Санкт-Петербург</region>
         <area_fias_id />
         <area_kladr_id />
         <area_with_type />
         <area />
         <city_kladr_id>7800000900000000000000000</city_kladr_id>
         <city_with_type>г Пушкин</city_with_type>
         <city>Пушкин</city>
         <settlement_fias_id />
         <settlement_kladr_id />
         <settlement_with_type />
         <settlement />
         <street_kladr_id>7800000900000720000000000</street_kladr_id>
         <street_with_type>Московский пер</street_with_type>
         <street>Московский</street>
      </data>
   </suggestions>
</response>

Описание параметров

Response
ПараметрТипОписание
suggestionsarray of Response.SuggestionsСписок подсказок

Response.Suggestions
ПараметрТипОписание
valuestring

Адрес для отображения в подсказке

unrestricted_valuestring

Полный адрес

dataobject

Данные объекта

data.region_kladr_idstringКод КЛАДР региона
data.region_with_typestringНаименование региона с указанием типа
data.regionstringНаименование региона
data.area_fias_idstringКод ФИАС района в регионе
data.area_kladr_idstringКод КЛАДР района в регионе
data.area_with_typestringНаименование района в регионе с указанием типа
data.areastringНаименование района в регионе
data.city_kladr_idstringКод КЛАДР города
data.city_with_typestringНаименование города с указанием типа
data.citystringНаименование города
data.city_areastringНаименование района города
data.settlement_fias_idstringКод ФИАС населенного пункта
data.settlement_kladr_idstringКод КЛАДР населенного пункта
data.settlement_with_typestringНаименование населенного пункта с указанием типа
data.settlementstringНаименование населенного пункта
data.street_kladr_idstringКод КЛАДР улицы
data.street_with_typestringНаименование улицы с указанием типа
data.streetstringНаименование улицы
data.countrystringСтрана

Обработка ошибок

При возникновении ошибки HTTP-протокола при обращении к сервису будет выведено сообщение: 

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

{
   "errors": {
      "message": "Сервис временно недоступен. Попробуйте посчитать стоимость доставки чуть позже."
   }
}
<response>
   <errors>
      <message>Сервис временно недоступен. Попробуйте посчитать стоимость доставки чуть позже.</message>
   </errors>
</response>

Получение стандартизированных адресов

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/standardized_address.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "data":[ 
         "г. Санкт-Петербург Санкт-Петербург г невский 1 1 12",
         "Ленинградская обл Выборгский р-н гп Рощино невский 1 1 12",
         "Ленинградская обл Кировский р-н массив Горы-1 невский 1 1 12"
    ],
   "type":"address",
   "mode":"pretty"
}

Адрес метода: https://api.dellin.ru/v1/standardized_address.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <data>г. Санкт-Петербург Санкт-Петербург г невский 1 1 12</data>
   <data>Ленинградская обл Выборгский р-н гп Рощино невский 1 1 12</data>
   <data>Ленинградская обл Кировский р-н массив Горы-1 невский 1 1 12</data>
   <type>address</type>
   <mode>pretty</mode>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDНетstringID сессии, требуется для учета индивидуальных скидок. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
dataДаarray of stringДанные для стандартизации
typeДаstring

Тип запроса. В данном параметре всегда должно передаваться значение "address"

modeНетstring

Формат возвращаемых данных.

Доступные значения:

  • raw - данные в неформатированном виде
  • pretty - форматированные данные

Значение по умолчанию - "pretty"

Ответ метода

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

{  
   "data":[  
      {  
         "source":"г. Санкт-Петербург Санкт-Петербург г невский 1 1 12",
         "result":"Россия, г Санкт-Петербург, г Санкт-Петербург, пр-кт Невский, д 1 к 1, кв 12",
         "qc":"0",
         "postal_code":"190000",
         "country":"Россия",
         "region_kladr_id":"7800000000000000000000000",
         "region_with_type":"г Санкт-Петербург",
         "region":"Санкт-Петербург",
         "city_kladr_id":"7800000000000000000000000",
         "city_with_type":"г Санкт-Петербург",
         "city":"Санкт-Петербург",
         "street_kladr_id":"7800000000008850000000000",
         "street_with_type":"пр-кт Невский",
         "street":"Невский",
         "house":"1",
         "block":"1",
         "houseData":{
            "houseNumber":"1",
            "fraction":"3",
            "letter":"A",
            "building":"1",
            "structure":"4"
         },
         "flat":"12"
      }
   ]
}
<response>
   <data>
      <source>г. Санкт-Петербург Санкт-Петербург г невский 1 1 12</source>
      <result>Россия, г Санкт-Петербург, г Санкт-Петербург, пр-кт Невский, д 1 к 1, кв 12</result>
      <qc>0</qc>
      <postal_code>190000</postal_code>
      <country>Россия</country>
      <region_kladr_id>7800000000000000000000000</region_kladr_id>
      <region_with_type>г Санкт-Петербург</region_with_type>
      <region>Санкт-Петербург</region>
      <city_kladr_id>7800000000000000000000000</city_kladr_id>
      <city_with_type>г Санкт-Петербург</city_with_type>
      <city>Санкт-Петербург</city>
      <street_kladr_id>7800000000008850000000000</street_kladr_id>
      <street_with_type>пр-кт Невский</street_with_type>
      <street>Невский</street>
      <house>1</house>
      <block>1</block>
      <houseData>
         <houseNumber>1</houseNumber>
         <fraction>3</fraction>
         <letter>A</letter>
         <building>1</building>
         <structure>4</structure>
      </houseData>
      <flat>12</flat>
   </data>
</response>

Описание параметров

Response
ПараметрТипОписание
dataarray of Response.DataСписок стандартизированных адресов

Response.Data
ПараметрТипОписание
sourcestring

Исходный адрес одной строкой

resultstring

Стандартизованный адрес одной строкой

qcstring

Системный параметр

postal_codestring

Почтовый индекс

region_kladr_idstringКод КЛАДР региона
region_with_typestringНаименование региона с указанием типа
regionstring

Наименование региона

city_kladr_idstringКод КЛАДР города
city_with_typestringНаименование города с указанием типа
citystringНаименование города
street_kladr_idstringКод КЛАДР улицы
street_with_typestringНаименование улицы с указанием типа
streetstringНаименование улицы
housestringДом
blockstringКорпус
houseDataobjectИнформация о доме
houseData.houseNumberstringНомер дома
houseData.fractionstringДробь
houseData.letterstringЛитера
houseData.buildingstringКорпус
houseData.structurestringСтроение
flatstringКвартира

Обработка ошибок

При возникновении ошибки HTTP-протокола при обращении к сервису будет выведено сообщение: 

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

{
   "errors": {
      "message": "Сервис временно недоступен. Попробуйте посчитать стоимость доставки чуть позже."
   }
}
<response>
   <errors>
      <message>Сервис временно недоступен. Попробуйте посчитать стоимость доставки чуть позже.</message>
   </errors>
</response>