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

Обновлено 10.04.2024

137 кб

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

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

Доступ к методам предоставляется по запросу. Для получения доступа обратитесь в техническую поддержку на портале: https://helpdesk.dellin.ru/ или по адресу: api_support@dellin.ru.

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

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

Адрес метода: 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	Нет	string	ID сессии, требуется для учета индивидуальных скидок. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
query	Да	string	Строка для поиска подсказок
city_code	Да	string	Код КЛАДР населенного пункта. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР"
count	Нет	integer	Количество требуемых подсказок. Доступные значения - от 1 до 20. Значение по умолчанию - 20
mode	Нет	string	Формат возвращаемых данных. Доступные значения: raw - данные в неформатированном виде pretty - форматированные данные Значение по умолчанию - "pretty"

Ответ метода

Структура ответа

JSON
XML

{ 
   "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
Параметр	Тип	Описание
suggestions	array of Response.Suggestions	Список подсказок

Response.Suggestions
Параметр	Тип	Описание
value	string	Адрес для отображения в подсказке
unrestricted_value	string	Полный адрес
data	object	Данные объекта
data.region_kladr_id	string	Код КЛАДР региона
data.region_with_type	string	Наименование региона с указанием типа
data.region	string	Наименование региона
data.area_fias_id	string	Код ФИАС района в регионе
data.area_kladr_id	string	Код КЛАДР района в регионе
data.area_with_type	string	Наименование района в регионе с указанием типа
data.area	string	Наименование района в регионе
data.city_kladr_id	string	Код КЛАДР города
data.city_with_type	string	Наименование города с указанием типа
data.city	string	Наименование города
data.city_area	string	Наименование района города
data.settlement_fias_id	string	Код ФИАС населенного пункта
data.settlement_kladr_id	string	Код КЛАДР населенного пункта
data.settlement_with_type	string	Наименование населенного пункта с указанием типа
data.settlement	string	Наименование населенного пункта
data.street_kladr_id	string	Код КЛАДР улицы
data.street_with_type	string	Наименование улицы с указанием типа
data.street	string	Наименование улицы
data.country	string	Страна

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

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

Структура ответа

JSON
XML

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

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

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

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

Структура запроса

JSON
XML

Адрес метода: 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	Нет	string	ID сессии, требуется для учета индивидуальных скидок. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
data	Да	array of strings	Данные для стандартизации
type	Да	string	Тип запроса. В данном параметре всегда должно передаваться значение "address"
mode	Нет	string	Формат возвращаемых данных. Доступные значения: raw - данные в неформатированном виде pretty - форматированные данные Значение по умолчанию - "pretty"

Ответ метода

Структура ответа

JSON
XML

{  
   "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
Параметр	Тип	Описание
data	array of Response.Data	Список стандартизированных адресов

Response.Data
Параметр	Тип	Описание
source	string	Исходный адрес одной строкой
result	string	Стандартизованный адрес одной строкой
qc	string	Системный параметр
postal_code	string	Почтовый индекс
region_kladr_id	string	Код КЛАДР региона
region_with_type	string	Наименование региона с указанием типа
region	string	Наименование региона
city_kladr_id	string	Код КЛАДР города
city_with_type	string	Наименование города с указанием типа
city	string	Наименование города
street_kladr_id	string	Код КЛАДР улицы
street_with_type	string	Наименование улицы с указанием типа
street	string	Наименование улицы
house	string	Дом
block	string	Корпус
houseData	object	Информация о доме
houseData.houseNumber	string	Номер дома
houseData.fraction	string	Дробь
houseData.letter	string	Литера
houseData.building	string	Корпус
houseData.structure	string	Строение
flat	string	Квартира

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

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

Структура ответа

JSON
XML

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

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

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

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

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

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

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

Структура запроса

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

Ответ метода

Структура ответа

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

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

Структура ответа

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

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

Структура запроса

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

Ответ метода

Структура ответа

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

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

Структура ответа