Начало работы с виджетами

Виджет - это архив, содержащий набор файлов, которые будут подключаться в amoCRM всем аккаунтам, включившим виджет. Виджет позволяет получить дополнительный функционал, если необходимо:

  • Отображать дополнительные данные в интерфесах amoCRM. Для виджетов предусмотрены специальные области, где вы можете вывести информацию. Например, вывести статистику обращений по контакту из внутренней системы;
  • Взаимодействовать с пользователем, с введенными им данными. Вы можете подключать JS-скрипты практически в любом интерфейсе системы. Например, можно показывать вслывающую карточку при поступающем звонке;
  • Чтобы администратор аккаунта amoCRM ввел индивидуальные настройки для вашего сервиса. Например, ключ авторизации в вашем API.

Во всех остальных случаях вы можете просто использовать открытое API amoCRM.

Рейтинг и отзывы виджетов

Оценить и оставить отзыв могут администраторы аккаунтов на странице настройки интеграций, в том случае, если виджет включен.

Можно поставить только оценку или добаавить к ней отзыв.

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

Создание виджета

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

  1. Регистрация аккаунта
  2. Генерация ключа виджета
  3. Загрузка архива виджета с PHP-библиотекой и примером виджета
  4. Подготовка структуры
  5. Работа с manifest.json
  6. Подготовка файлов локализации
  7. Разработка JS-скрипта
  8. Упаковка и загрузка архива

Мы будем рассматривать вариант без подключения PHP-библиотеки, основанный только на JavaScript. О работе с PHP вы сможете прочитать в разделе PHP-библиотека.

1. Регистрация аккаунта

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

При загрузке виджета он будет доступен только внутри вашего аккаунта, пока не будет премодерирован нашими сотрудниками.

Для моего первого виджета я зарегистрирую аккаунт с параметрами:

PARAMETERVALUE
User email: email@amocrm.com
Account address: demoaccount.amocrm.com

2. Генерация ключа виджета

Внутри аккаунта заходим на страницу /settings/dev/. Это страница разработчика и для меня ссылка будет выглядеть так https://demoaccount.amocrm.com/settings/dev/. На ней вы можете сгенерировать ваш первый ключ, здесь же будет происходить загрузка виджетов, можно просмотреть уже загруженные виджеты.

Введите код виджета (только строчные буквы!). Код виджета не будет виден конечным пользователям, только в коде, как идентификатор. В ответ вы получите ключ уникальный для вашего виджета, который будет использован дальше.

Должно получиться примерно следующее:

PARAMETERVALUE
Код: new_widget
Ключ:57009cb5048a72191f25b01355c17d10dc349df20d4fe2ad0c69930223e13955

3. Загружаем пример виджета.

Вы можете всегда загрузить актуальную версию на странице разработчика. А можете кликнуть на ссылку ниже.

Скачать

Next Step: Structure