На этой странице приведены примеры взаимодействия расширения с CRM и его пользователями, лучшие практики и требования к визуальному оформлению элементов.
Легко привести расширение к соответствию требованиям по визуальному оформлению можно с помощью универсального AI-навыка.
Рекомендации
по визуальному оформлению
Старайтесь использовать оформление страниц и элементов, соответствующее стилистике laxo CRM:
- Перед публикацией проверяйте отображение страниц на настольных и мобильных устройствах.
- Используйте элементы фирменного стиля laxo (посмотреть подробный гайдлайн в Figma).
- Поддерживайте светлую и тёмную темы оформления. Пользовательская настройка
darkThemeдоступна вlocalStorageи в ответеuser_session.get_config. - Используйте выбранный пользователем цвет элементов: ключ
colorElementsвlocalStorageилиuser_session.get_config. - Для собственных HTML-страниц отдельно подключайте шрифт
Open Sansи необходимые иконкиFont Awesome. Они не наследуются из родительской страницы, но доступны по следующим ссылкам:
| Шрифт | Ссылка |
|---|---|
| Open Sans Regular | https://laxo.one/assets/themes/laxo/fonts/OpenSans-Regular.woff2 |
| Open Sans Italic | https://laxo.one/assets/themes/laxo/fonts/OpenSans-Italic.woff2 |
| Open Sans SemiBold | https://laxo.one/assets/themes/laxo/fonts/OpenSans-SemiBold.woff2 |
| Font Awesome Light | https://laxo.one/assets/themes/laxo/fonts/fa-light-300.woff2 |
| Font Awesome Regular | https://laxo.one/assets/themes/laxo/fonts/fa-regular-400.woff2 |
| Font Awesome Solid | https://laxo.one/assets/themes/laxo/fonts/fa-solid-900.woff2 |
Легко привести расширение к соответствию требованиям по визуальному оформлению можно с помощью универсального AI-навыка.
Взаимодействие
с API
Обращаться к API можно как из клиентской части, так и серверной. Используйте актуальные способы обращения к API и описания методов, которые опубликованы в этом разделе.
Предполагается, что все действия в клиентской части должны происходить от имени пользователя, который их инициирует. Для действий от имени расширения, например создание сделки на основе заполненной внешней формы, используйте системного пользователя или API-токен.
Для действий от имени пользователя используйте его sid: из cookie или sessionStorage по имени/ключу _sid или вызвав метод user_session.auth, если требуется авторизация.
// Пример получения SID пользователя
const sidCookie = document.cookie.match(/(?:^|;\s*)_sid=([^;]*)/);
const sid = (sidCookie && decodeURIComponent(sidCookie[1])) || sessionStorage.getItem('_sid') || sessionStorage.getItem('sid');
// Если SID обязателен для дальнейшей работы
if (!sid) {
return false;
}При разработке предусматривайте сценарии, что
sidможет быть отозван, например по истечении срока действий. Не рекомендуется хранениеsidпользователей во внешних источниках.
Один обработчик
для нескольких страниц или событий
Если одинаковый код должен выполняться при открытии нескольких страниц или для разных действий, сформируйте элементы с помощью map(), чтобы избежать дублирования. В этом примере обработчик для mountedPage добавляется для списков и карточек контактов и сделок:
mountedPage: [
'ContactList',
'ContactView',
'OrderList',
'OrderView'
].map(function (target) {
return {
target: target,
integrationName: 'crm_name_ext_name', // Идентификатор расширения
functionName: function () {
/** Здесь размещается общий код обработчика */
}
};
})Создание дополнительных
полей для расширений
Расширения могут иметь собственные дополнительные поля, например для хранения внутренних идентификаторов внешних сервисов. Создать такие поля можно через обращение к методу API field.add как в серверной части, например при включении, а также в клиентской, добавив код в ключ nativeInit, который вызывается после каждого включения расширения.
Важно: перед созданием дополнительных полей или других компонентов проверяйте, существуют ли они, так как расширение может выключаться и включаться повторно – это не должно создавать дубликаты.
Полный список возможных типов полей доступен на этой странице.
Для технических имён дополнительных полей используйте формат crm_name_ext_name_field_name: аккаунт разработчика, имя расширения и имя поля.
Используйте скрытые дополнительные поля, если иное не требуется согласно назначению расширения.
Уведомления
Для мгновенных уведомлений пользователя через интерфейс в laxo предусмотрен публичный метод setNoti, который запускает всплывающее окно:
window.Laxo.Format.setNoti({
text: 'Have a good day!', // Текст уведомления
link: {
name: '...', // Имя страницы (например из extensionPage[].name) или URL для внешних ссылок
text: '...', // Текст ссылки
external: true // Признак внешней ссылки
},
type: 'success', // Стиль уведомления: success (успешно), failed (ошибка)
iframe: {
srcdoc: '<div>Some html...</div>', // HTML-код, который должен быть добавлен в окно уведомления
style: 'border:0;' // Кастомный стиль для тега iframe
}
});Для генерации классических уведомлений, которые хранятся в истории событий и, в зависимости от настроек пользователя, отправляются на почту, в push или в область уведомлений используйте метод notification.create_custom в API.