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

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

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

Обновлено 28.08.2020
111 кб

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

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

Все методы из данного раздела имеют одинаковую структуру запросов и ответов. Примеры структуры запросов и ответов методов приведены ниже. Исключение составляет метод "Справочник стран", описание метода приведено в соответствующем разделе.

Рекомендуемая частота обновления скачанных CSV файлов с данными справочников - раз в месяц

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

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

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}
<request>
   <appkey>00000000-0000-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", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

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

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "filter":"Бел"
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <filter>Бел</filter>
</request>

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

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

Часть названия страны. Используется для подбора результата по началу строки.

Подбор осуществляется только в том случае, если в запросе передан один параметр.

Если в запросе передано несколько параметров, то ответе приводится полный список стран

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "countryUID":"0x8f51001438c4d49511dbd774581edb7e",
         "country":"Беларусь"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <countryUID>0x8f51001438c4d49511dbd774581edb7e</countryUID>
      <country>Беларусь</country>
   </data>
</response>

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

Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация о стране
data.countryUIDstringUID страны
data.countrystringНаименование страны

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

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

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

Адрес метода для запроса в формате 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 МБ