Для работы с API потребуется получить токен в ФНС РФ. Процедура получения токена подробно рассмотрена в видео в конце статьи.
Приложенная конфигурация тестировалась на платформе 8.3.15.
Описание функций:
Функция ПолучитьАдресПоПроизволнойСтрокеПоиска(Токен, СтрокаПоиска)
возвращает список возможных адресов по строке поиска, при этом в первой строке списка содержит наиболее подходящий вариант для строки поиска.
Параметры функции: токен, произвольная строка поиска (например, "Москва, Арбат, д.1").
Функция возвращает таблицу значений со следующими колонками:
- "full_name" - представление адреса
- "object_guid" - идентификатор ГАР (ФИАС)
- "path" - путь (id адресных элементов через точку, например "211522.95235590.211338.214198.6166221.6166938")
- "postal_code" - почтовый индекс
- "okato" - ОКАТО
- "oktmo" - ОКТМО
- "cadastral_number" - кадастровый номер адресного объекта
Функция ПолучитьАдресПоИдентификаторуГАР(Токен, ИдентификаторГАР)
функция преобразования идентификатора ГАР в адрес.
Параметры функции: токен, идентификатор ГАР (ФИАС)
Функция возвращает структуру:
- "full_name" - представление адреса
- "postal_code" - почтовый индекс
- "okato" - ОКАТО
- "oktmo" - ОКТМО
- "cadastral_number" - кадастровый номер
Функция ПолучитьСписокРегионов(Токен)
возвращает список регионов РФ.
Параметр: токен.
Функция возвращает таблицу значений:
- "object_id" - id адресного объекта
- "object_level_id" - уровень адресного объекта, здесь всегда будет 1 - самый "верхний" уровень
- "full_name" - представление адреса
- "region_code" - код региона (например, для Москвы - 77)
Функция ПолучитьСписокАдресныхЭлементов(Токен, Путь)
возвращает иерархию адресных элементов начиная от элемента, заданного параметром Путь. Путь - это цепочка id-шников адресных объектов, записанных через точку (например, "211522.95235590.211338").
Параметры: токен, путь.
Функция возвращает таблицу значений, содержащую нижестоящие адресные элементы по отношению к параметру "Путь":
- "object_id" - id адресного объекта
- "object_level_id" - уровень адресного объекта
- "full_name_item" - представление адресного объекта
- "full_name" - представление адреса целиком, включая путь и текущий адресный элемент
- "path" - путь для данного адресного элемента
- "object_guid" - идентификатор ГАР
- "postal_code" - почтовый индекс
- "okato" - ОКАТО
- "oktmo" - ОКТМО
- "cadastral_number" - кадастровый номер адресного объекта
Подробно о функциях и их использовании смотрите видео:
