Manifest.json и виджеты amoCRM: что нужно знать

Разработка виджетов для amoCRM предполагает тесное взаимодействие с файлом manifest.json. Данный файл является ключевым элементом‚ описывающим функциональность‚ настройки и параметры виджета. В настоящей статье представлен подробный обзор структуры и основных параметров manifest.json‚ а также особенности его использования при интеграции виджетов в amoCRM‚ включая поддержку веб-форм.

Структура файла Manifest.json

Manifest.json представляет собой JSON-файл‚ содержащий метаданные о виджете. Основные секции файла включают:

• code: Уникальный идентификатор виджета. Этот код генерируется при создании виджета в amoCRM и должен быть указан в файле manifest.json для корректной идентификации виджета системой.
• secret_key: Секретный ключ‚ также генерируемый в amoCRM. Он используется для аутентификации виджета и обеспечения безопасности.
• name: Отображаемое имя виджета в интерфейсе amoCRM.
• description: Краткое описание функциональности виджета.
• version: Версия виджета.
• locations: Определяет области в amoCRM‚ где виджет будет отображаться.
• amoforms_settings: (Начиная с релиза Весна 2021) Необходим для поддержки работы виджета в веб-формах. Включает параметр location со значением amoforms.

Настройка Manifest.json для интеграции с amoCRM

Для успешной установки виджета в amoCRM необходимо выполнить следующие шаги:

1. Замена code и secret_key: В файле manifest.json замените значения полей code и secret_key на значения‚ сгенерированные для вашего виджета в amoCRM.
2. Определение областей подключения: Укажите области в amoCRM‚ где виджет должен быть отображен‚ в секции locations.
3. Поддержка веб-форм: Если виджет должен работать в веб-формах‚ добавьте секцию amoforms_settings с параметром location: "amoforms".

Распространенные ошибки и их решение

При загрузке виджета в amoCRM могут возникать следующие ошибки:

• “Manifest.json не найден”: Убедитесь‚ что файл manifest.json присутствует в архиве виджета и имеет правильное имя.
• “Secret key for this widget code is not correct”: Проверьте правильность указанных значений code и secret_key в файле manifest.json. Убедитесь‚ что они соответствуют значениям‚ сгенерированным в amoCRM.

Размещение файлов виджета

В соответствии с документацией amoCRM‚ PHP-файлы виджета должны храниться на вашем сервере. Файлы manifest.json и script.js загружаются в amoCRM в виде архива. После загрузки архива необходимо создать виджет внутри amoCRM и сгенерировать код виджета и ключ‚ которые затем указываются в файле /dist/manifest.json.

Создание страницы настроек виджета

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

Файл manifest.json является неотъемлемой частью разработки виджетов для amoCRM. Понимание его структуры и правильная настройка параметров позволяют успешно интегрировать виджеты в систему и расширить ее функциональность. Внимательное отношение к деталям и соблюдение рекомендаций‚ представленных в документации amoCRM‚ помогут избежать распространенных ошибок и обеспечить стабильную работу виджета.