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

API
Главная / API - Местоположения

Местоположения

Обновлено 08.08.2017
74 кб

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

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

Все методы из данного раздела имеют одинаковую структуру запросов и ответов:

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

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

{
   "appkey": "00000000-0000-0000-000000000000"
}
<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
</request>

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

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

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

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

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

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут).

Вместо "[filename]" значение данного параметра содержит наименование файла, совпадающее с ключевым словом в наименовании соответствующего метода.

Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Справочник стран

Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/countries.json

Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/countries.xml

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки: 

  • CountryUID — уникальный идентификатор;
  • country — наименование.

Справочник городов из прайс-листа

Данный справочник содержит перечень городов, которые есть в прайс-листе. Отправки в эти города совершаются без дополнительного согласования стоимости. Не следует путать данный справочник со "Справочником населенных пунктов".

Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/cities.json  

Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/cities.xml 

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • id — уникальный идентификатор города;
  • name — наименование города;
  • codeKLADR — код КЛАДР города;
  • isTerminal — флаг наличия терминала в городе.

Справочник населенных пунктов с безналичной оплатой

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

Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/cities_cashless_only.json  

Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/cities_cashless_only.xml 

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки: 

  • cityID — уникальный идентификатор города в рамках нашей системы;
  • cityCode — код КЛАДР города.

Справочник населенных пунктов

Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/places.json

Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/places.xml

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • cityID — уникальный идентификатор города в рамках нашей системы;
  • name — полное наименование населённого пункта;
  • code — код КЛАДР населенного пункта;
  • searchString — наименование населённого пункта, сформированное специальным образом для поиска. Например, для реализации автодополнения;
  • regname — наименование региона для населённого пункта;
  • regcode — код КЛАДР региона для населённого пункта;
  • zonename — наименование района для населённого пункта;
  • zoncode — код КЛАДР района для населённого пункта.
Обратите внимание, что данный справочник содержит несколько сотен тысяч записей. Его объем составляет более 40 МБ.
Рекомендуем Вам кэшировать данный справочник на своей стороне на длительное время, так как он обновляется достаточно редко.

Справочник улиц

Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/streets.json

Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/streets.xml

Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:

  • code — код КЛАДР улицы;
  • cityID — уникальный идентификатор города в рамках нашей системы;
  • searchString — наименование улицы сформированное специальным образом для поиска, например для реализации автодополнения;
  • name — полное наименование улицы.
Обратите внимание, что данный справочник содержит несколько сотен тысяч записей. Его объем составляет более 80 МБ.
Рекомендуем Вам кэшировать данный справочник на своей стороне на длительное время, так как он обновляется достаточно редко.