Руководство разработчика плагина «Подсказок» для CMS

Подсказки отлично встраиваются в любые CMS, интернет-магазины и веб-фреймворки благодаря готовому jQuery-плагину. У подсказок уже больше 80 интеграций, в том числе Битрикс, amoCRM, 1С и WordPress.

В простейшем случае модуль для CMS выступает просто «оберткой» над плагином, которая натравливает плагин на нужные поля. Но есть нюансы.

Рекомендуем использовать возможности «Дадаты» по максимуму, и навешивать подсказки на все подходящие поля:

• На форме регистрации: ФИО и email.
• На форме заказа для физических лиц: ФИО, адрес и email.
• На форме заказа для организаций: реквизиты компании и банка.
• В личном кабинете: ФИО, адрес, email, реквизиты компании и банка.
• На форме обратной связи: ФИО и email.

Стандартные настройки подходят для большинства случаев, но иногда имеет смысл их «подкрутить»:

ФИО

Базовый вариант — ФИО одной строкой.

Иногда нужно не полное ФИО, а имя+фамилия или просто имя. Подсказки это умеют:

• имя + фамилия;
• только имя.

Некоторые CMS требуют вводить фамилию, имя и отчество в отдельные поля. Мы такой подход не рекомендуем (неудобно для пользователя), но если поведение CMS никак не изменить — подсказки умеют и гранулярное ФИО.

Адрес

Базовый вариант — адрес одной строкой.

Адрес отдельными полями

Часто адрес одной строкой не подходит, потому что CMS хочет более гранулярное значение. Например, отдельно город, чтобы понять стоимость доставки, или отдельно индекс для печати на конверте, или отдельно вообще все поля, потому ну вот так и всё тут. Подсказки поддерживают всё многообразие вариантов, выбирайте подходящий:

• адрес до дома одной строкой + квартира отдельно;
• адрес до улицы одной строкой + дом отдельно;
• город, улица, дом;
• регион, город, улица, дом;
• все поля.

Город

Если город заполняется средствами CMS, обратите особое внимание на то, чтобы корректно передать этот город подсказкам. Для этого используйте ограничение области поиска:

• по КЛАДР-коду,
• по ФИАС-коду,
• или названию города.

Предпочтительно использовать КЛАДР-код или ФИАС-код, потому что название города в CMS может отличаться от названия города в подсказках.

Так или иначе, передать город подсказкам обязательно надо, иначе они будут подсказывать адреса по всей стране, что вызовет законное негодование пользователей. Если не знаете, как это лучше сделать для вашей CMS — задайте вопрос в службу поддержки.

Индекс

Вне зависимости от выбранной конфигурации, можете добавить поле «индекс» с автоматическим заполнением по адресу. Главное, не ставьте поле «индекс» первым, чтобы человек не бросился заполнять его вручную.

Адреса, которых нет в подсказках

Обязательно оставьте человеку возможность ввести адрес, которого нет в подсказках. Подсказки знают о большинстве адресов, но не о всех. Так что если ограничить ввод только подсказками — некоторые люди не смогут указать свой адрес. Посмотрите, как это делают Яндекс.Деньги:

Не обязательно делать отдельную форму ввода для «незнакомых» адресов. Если вы оставите поведение плагина по-умолчанию, он даст возможность ввести любой адрес. Главное — не запрещайте специально ввод адресов, которых нет в подсказках.

Email

По умолчанию подсказки по емейлу подсказывают и локальную часть (которая до «собачки»), и доменную (которая после «собачки»). Для CMS рекомендуем использовать более консервативный вариант — подсказки только по доменной части.

Организация и банк

Заполнять реквизиты организации или банка — ужасно утомительное занятие, поэтому всегда используйте подсказки:

• по организации;
• по банку.

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

По умолчанию подсказки работают как по названию организации, так и по ИНН. Лучше не менять это поведение и не делать подсказки только по ИНН — это неудобно.

Количество подсказок в списке

По умолчанию подсказки предлагают не более 5 вариантов. Рекомендуем оставить эту настройку как есть, потому что больше 5 пунктов в выпадающем списке люди всё равно не воспринимают.

Идентификатор разработчика

Чтобы различать модули Подсказок между собой и оценивать их популярность, мы предусмотрели в плагине идентификатор разработчика. Он задаётся в параметре partner:

$("#address").suggestions({
    token: "АПИ_КЛЮЧ",
    type: "ADDRESS",
    partner: "ИДЕНТИФИКАТОР_РАЗРАБОТЧИКА"
});

Все «идентифицированные» модули попадают на главную страницу подсказок, а ещё мы пишем о них в соцсетях, email-рассылках, и рекомендуем пользователям при личном общении.

Чтобы получить идентификатор разработчика, напишите нам на info@dadata.ru

Описание

Хорошее описание поможет лучше продавать ваш модуль. Минимально хорошее описание включает:

• пояснение пользы для клиента;
• скриншоты, как выглядят подсказки в интерфейсе;
• инструкцию по подключению;
• контакты для обратной связи и багрепортов;
• и цену ツ

Польза для клиента

Если не хотите писать свой текст, воспользуйтесь готовым:

Вручную вводить ФИО, email и особенно адрес — неудобно. Люди ошибаются и неправильно заполняют поля, а некоторые вовсе уходят, если форма слишком сложная. Менеджерам приходится перезванивать и уточнять детали, впустую тратя время компании и клиента.

Решение — модуль для быстрого ввода любых контактных данных: адресов, ФИО, email, реквизитов компаний и банков. С ним клиенты легко вводят правильные данные, а заказы готовы к доставке без перезвона и уточнения деталей.

Логотип

Если решите использовать логотип Дадаты, то вот он в векторе (SVG):

https://dadata.ru/static/i/dadata-logo.svg

Скриншоты

Пример:

Монетизация

У людей не всегда получается заставить работать модуль для CMS с первого раза — поэтому требуется техподдержка. Так что лучше сделать модуль платным и консультировать покупателей, чем бесплатным, но отвечать «ничем помочь не могу».

Чтобы дополнительно заработать, подключайтесь к партнёрской программе — возвращаем 30% от сумм, потраченных вашими клиентами.

Если что-то не получается

Если подсказки ведут себя не так, как вы от них ожидаете, не торопитесь возводить костыли. Задайте вопрос в службу поддержки. Мы заинтересованы в высоком качестве вашего модуля, поэтому с радостью поможем.

Перед выпуском модуля

1. Убедитесь, что используете свежую версию плагина подсказок. Возьмите его с сайта «Дадаты»: https://dadata.ru/suggestions/usage/
2. Получите в службе поддержки идентификатор разработчика (параметр partner) и встройте в модуль. Не пропускайте этот шаг: без идентификатора разработчика мы не сможем поставить ссылку на модуль на сайт и написать о нём в рассылке.
3. Сделайте демо-страницу, на которой люди смогут посмотреть модуль в работе.
4. Подготовьте инструкцию по установке.
5. Напишите нам на info@dadata.ru, что модуль готов. Дайте ссылку на демо и инструкцию по установке.
6. PROFIT!