Модуль интеграции с DaData

Модуль для интеграции с сервисом DaData, который позволяет ускорить заполнение форм и проверить введённые данные.

После подключения модуля в дизайнере интерфейсов будут доступны специальные виджеты. На страницах и формах приложений они будут отображаться в виде строки поиска и полей с данными, которые автоматически заполняются информацией, полученной из модуля DaData.

Виджеты, входящие в модуль:

  • Поиск компании — помогает пользователю быстро ввести реквизиты организации. Находит компанию или индивидуального предпринимателя по ИНН, КПП, ОГРН. Возвращает реквизиты компании, руководителей и другую информацию о компании;
  • Поиск банка — помогает быстро ввести реквизиты банка. Находит банк по любому из идентификаторов: БИК, SWIFT, ИНН, ИНН + КПП (для филиалов) или регистрационному номеру Банка России. Возвращает реквизиты банка, корр. счёт, адрес и статус — действующий или на ликвидации;
  • Проверка паспорта — проверяет паспорт по справочнику недействительных паспортов МВД. Заполняет организацию, выдавшую паспорт, по коду подразделения;
  • Проверка e-mail — проверяет на одноразовый адрес. Классифицирует адреса на личные (@mail.ru, @yandex.ru), корпоративные (@companyname.com) и ролевые (info@, support@). Помогает пользователю быстро ввести адрес электронной почты;
  • Поиск адреса — помогает быстро ввести корректный адрес. Разбивает адрес из строки по отдельным полям (регион, город, улица, дом, квартира) согласно КЛАДР/ФИАС (ГАР). Определяет почтовый индекс, часовой пояс, ближайшее метро, координаты, стоимость квартиры и другую информацию об адресе.

Настроить модуль

Начало внимание 

Перед началом настройки убедитесь, что ваш аккаунт в DaData активен.

Конец внимание 

  1. Зайдите в личный кабинет вашего аккаунта DaData.
  2. Скопируйте API-ключ и Секретный ключ.
  3. Перейдите в ELMA365. На главной странице в левом меню нажмите на значок settings_icon. В открывшемся окне Настройка разделов и Решений перейдите на вкладку Решения.
  4. Нажмите кнопку +Добавить решение и выберите опцию Скачать.
  5. В каталоге ELMA365 Store установите модуль Интеграция с DaData.
  6. После успешной установки перейдите в Администрирование > Модули > Интеграция с DaData.
  7. Вставьте скопированные на шаге 2 API-ключ и Секретный ключ в соответствующие поля.

dadata-1

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

Если в настройках модуля не указан секретный ключ или подключение по секретному ключу произошло с ошибкой, проверка паспорта и e-mail будет недоступна.

  1. Нажмите кнопку Проверить подключение. Если связь между системами установлена, вы увидите уведомление об этом.
  2. Нажмите кнопку Сохранить.

Настройка виджетов

После подключения модуля DaData пользователи из группы Администраторы могут добавить входящие в модуль виджеты на страницы и формы приложений.

Например, в разделе CRM на формы создания и редактирования приложения Компании можно добавить виджеты Поиск компании и Поиск банка. А на формы приложения Контакты — виджеты Проверка паспорта, Проверка e-mail и Поиск адреса.

Чтобы разместить виджет на форме, перейдите в дизайнер интерфейсов. Перетащите виджет с правой панели дизайнера на поле для моделирования или нажмите кнопку +Виджет. Подробнее о добавлении виджетов читайте в статье «Шаблон формы».

Откроется окно настроек, которое состоит из двух вкладок:

  • Вкладка «Основные» — индивидуальна для каждого виджета. Содержит параметры, отвечающие за работу и внешний вид виджета;
  • Вкладка «Системные» — настройки одинаковы для всех виджетов. Позволяют управлять видимостью виджетов и доступом к ним, настраивать их поведение при наведении курсора и т. д. Подробнее можно прочитать в статье «Системные настройки виджетов».

Виджет «Поиск компании»

dadata-2

  1. При необходимости отредактируйте заголовок, который отображается над строкой поиска, и текст подсказки, который отображается под строкой.
  2. В поле Показать полученные данные выберите Да, чтобы на форме отображались все поля, которые автоматически заполняются значениями, полученными из сервиса DaData. По умолчанию параметр установлен в положение Нет, и на форме отображается только строка поиска компании.
  3. Остальные поля автоматически заполняются данными из сервиса DaData. Их необходимо связать со свойствами приложения. Для этого нажмите на значок instruction_2 справа от названия поля, затем на ссылку <Не установлено>. В открывшемся списке выберите соответствующее свойство приложения.
  4. Для завершения настройки виджета нажмите кнопку Сохранить, а затем Опубликовать на верхней панели дизайнера интерфейсов.
  5. После этого откройте настроенную форму и начните вводить данные в строку поиска. В открывшемся списке компаний выберите нужную и убедитесь, что сервис DaData возвращает данные по компании: ИНН, КПП, ОГРН и другие реквизиты.

dadata-3

Виджет «Поиск банка»

dadata-4

  1. При необходимости отредактируйте заголовок, который отображается над строкой поиска, и текст подсказки, который отображается под строкой.
  2. В поле Показать полученные данные выберите Да, чтобы на форме отображались все поля, которые автоматически заполняются значениями, полученными из сервиса DaData. По умолчанию параметр установлен в положение Нет, и на форме отображается только строка поиска банка.
  3. Остальные поля автоматически заполняются данными из сервиса DaData. Их необходимо связать со свойствами приложения. Для этого нажмите на значок instruction_2 справа от названия поля, затем на ссылку <Не установлено>. В открывшемся списке выберите соответствующее свойство приложения.
  4. Для завершения настройки виджета нажмите кнопку Сохранить, а затем Опубликовать на верхней панели дизайнера интерфейсов.
  5. После этого откройте настроенную форму и начните вводить данные в строку поиска банка. В открывшемся списке кредитных организаций выберите нужную и убедитесь, что сервис DaData возвращает данные: БИК, ИНН, КПП и другие реквизиты.

dadata-5

Виджет «Проверка паспорта»

dadata-6

  1. Отметьте поле Серия и номер паспорта обязательным для заполнения.
  2. В поле Показать полученные данные выберите Да, чтобы на форме отображались все поля, которые автоматически заполняются значениями, полученными из сервиса DaData. По умолчанию параметр установлен в положение Нет, и на форме отображаются только поле для ввода серии и номера паспорта, а также кода подразделения, выдавшего паспорт.  
  3. Остальные поля автоматически заполняются данными из сервиса DaData. Их необходимо связать со свойствами приложения. Для этого нажмите на значок instruction_2 справа от названия поля, затем на ссылку <Не установлено>. В открывшемся списке выберите соответствующее свойство приложения.
  4. Для завершения настройки виджета нажмите кнопку Сохранить, а затем Опубликовать на верхней панели дизайнера интерфейсов.
  5. После этого откройте настроенную форму и введите серию и номер паспорта. Если в настройках модуля указаны действующие API-ключ и Секретный ключ, в сервисе DaData произойдёт проверка паспорта по справочнику недействительных паспортов МВД. Результат проверки отобразится на форме.
  6. В поле Код подразделения начните вводить данные. В открывшемся списке выберите нужное подразделение.

dadata-8

Виджет «Проверка e-mail»

dadata-9

  1. При необходимости измените настройки отображения строки ввода e-mail: отредактируйте заголовок строки и текст подсказки к ней.
  2. Отметьте поле e-mail обязательным для заполнения.
  3. В поле Показать полученные данные выберите Да, чтобы на форме отображалось поле Тип адреса.
  4. Поля e-mail и Тип адреса необходимо связать со свойствами приложения. Для этого нажмите на значок instruction_2 справа от названия поля, затем на ссылку <Не установлено>. В открывшемся списке выберите соответствующее свойство приложения.
  5. Для завершения настройки виджета нажмите кнопку Сохранить, а затем Опубликовать на верхней панели дизайнера интерфейсов.
  6. После этого откройте настроенную форму и начните вводить e-mail. После ввода символа «@» появится выпадающий список адресов с почтовыми доменами. Выберите нужный.

Если в настройках модуля указаны действующие API-ключ и Секретный ключ, после выбора e-mail в сервисе DaData произойдёт проверка типа электронной почты. Возможные типы: личный, корпоративный, ролевой, одноразовый или некорректный. Результат проверки отобразится на форме.
Также произвести проверку можно, нажав кнопку Проверить e-mail.

dadata-10

Виджет «Поиск адреса»

dadata-11

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

dadata-12

  1. В поле Показать полученные данные выберите Да, чтобы на форме отображались все поля, которые автоматически заполняются значениями, полученными из сервиса DaData. По умолчанию параметр установлен в положение Нет, и на форме отображаются только строка поиска адреса.
  2. Остальные поля автоматически заполняются данными из сервиса DaData. Их необходимо связать со свойствами приложения. Для этого нажмите на значок instruction_2 справа от названия поля, затем на ссылку <Не установлено>. В открывшемся списке выберите соответствующее свойство приложения.
  3. Для завершения настройки виджета нажмите кнопку Сохранить, а затем Опубликовать на верхней панели дизайнера интерфейсов.
  4. После этого откройте настроенную форму и начните вводить данные в строку поиска. В открывшемся списке адресов выберите нужный и убедитесь, что сервис DaData возвращает данные по нему.

dadata-13