Разработка плагинов

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

Схема работы

Предусмотрено 2 способа подключения плагина к интерфейсу CRM:

• фоновое подключение (в основном для скриптов PHP) - плагин подключается к системе Webhook и выполняет работу в фоновом режиме
• подключение к интерфейсу (в основном для JS-скриптов) - плагин подключается к интерфейсу системы и расширяет её функционал с помощью собственных js-скриптов

Важно

Более широкие возможности кастомизации системы предоставляет система Хуков и Фильтров.

Подключение плагина

Подключение плагина происходит с помощью системы Хуков и фильтров. При этом в папке с плагином должны присутсвовать 3 файла:

• plugin.json - файл с описанием плагина

  • package - название пакета ( латиница )
  • version - версия плагина
  • author - автор
  • authorurl - ссылка на сайт автора
  • link - ссылка на документацию по плагину
  • request - минимально требуемая версия
  • name - наименование плагина
  • description - описание плагина
  • screenshot - ссылка на изображение скриншота
  • menu - добавлять ли пункт в меню системы ( true/false )
  • icon - иконка для пункта меню ( см. /font/fontello/demo.html )
  • iconSVGinBase64 - иконка плагина в формате Base64
• uninstall.php - файл удаления плагина
• {pluginname}.php - файл, содержащий основную логику плагина, в т.ч. подключение к интерфейсу (название должно быть в нижнем регистре, без заглавных букв)

Пример описания:

{
  "package": "userNotifier",
  "version": "2.0",
  "author": "SalesMan Team",
  "authorurl": "https://salesman.pro/",
  "link": "https://salesman.pro/docs/124",
  "request": "2019.4",
  "name": "Уведомление пользователей CRM (Боты)",
  "description": "Плагин позволяет отправлять уведомления по событиям в SalesMan CRM в поддерживаемые мессенджеры (Telegram, Viber, Slack). Пользователь самостоятельно может подписаться или отписаться на уведомления. Все сообщения отправляются приватно.",
  "textdomain": "usernotifier",
  "screenshot": "https://salesman.pro/docs.img/docs/usernotifier_telegram.png",
  "menu": true,
  "icon": "icon-paper-plane-empty",
  "iconSVGinBase64": "<svg id="Layer_1" enable-background="new 0 0 512 512" height="512" viewBox="0 0 512 512" width="512" xmlns="http://www.w3.org/2000/svg"><path d="m234.03 360.681v-92.997c0-10.004 1.533-19.657 4.376-28.747h-224.959c-3.285 0-5.947 2.685-5.947 5.997v130.116c0 3.312 2.663 5.997 5.947 5.997h27.953v43.59c0 2.426 1.449 4.613 3.671 5.541.736.307 1.509.457 2.275.457 1.547 0 3.069-.609 4.207-1.756l47.437-47.831h120.62z" fill="#62dafa"/><path d="m34 375.049v-130.116c0-3.312 2.663-5.997 5.947-5.997h-26.5c-3.285 0-5.947 2.685-5.947 5.997v130.116c0 3.312 2.663 5.997 5.947 5.997h26.5c-3.284 0-5.947-2.685-5.947-5.997z" fill="#01cffa"/><path d="m333.799 169.794h14.03c6.816 0 13.472.676 19.903 1.955v-16.024c0-10.86-9.057-19.745-20.125-19.745h-13.585c-11.069 0-20.125 8.885-20.125 19.745v16.02c6.432-1.278 13.087-1.951 19.902-1.951z" fill="#fde35a"/><path d="m333.799 169.794h4.366v-14.07c0-9.044 6.289-16.699 14.783-19.012-1.705-.465-3.491-.733-5.341-.733h-13.585c-11.069 0-20.125 8.885-20.125 19.745v16.02c6.432-1.277 13.087-1.95 19.902-1.95z" fill="#f9c500"/><path d="m298.357 439.359c.622 23.114 19.386 41.662 42.458 41.662 23.073 0 41.836-18.548 42.457-41.662z" fill="#fdd302"/><path d="m330.022 439.359h-31.666c.622 23.114 19.386 41.662 42.458 41.662 5.6 0 10.941-1.103 15.837-3.088-15.276-6.194-26.158-21.07-26.629-38.574z" fill="#e7b700"/><path d="m495.739 428.667-48.141-67.986v-76.799c-1.165.067-2.335.11-3.516.11-33.369 0-60.418-27.275-60.418-60.92 0-15.22 5.548-29.125 14.699-39.802-14.821-8.56-32.092-13.476-50.534-13.476h-14.03c-55.102 0-99.769 43.827-99.769 97.89v92.997l-48.141 67.986c-1.494 2.065-1.688 4.776-.505 7.028 1.186 2.251 3.552 3.665 6.133 3.665h298.593c2.583 0 4.948-1.414 6.132-3.665 1.186-2.252.991-4.964-.503-7.028z" fill="#fdd302"/><path d="m495.739 428.667-48.141-67.986h-213.568l-48.141 67.986c-1.494 2.065-1.688 4.776-.505 7.028 1.186 2.251 3.552 3.665 6.133 3.665h298.593c2.583 0 4.948-1.414 6.132-3.665 1.186-2.252.991-4.964-.503-7.028z" fill="#fde35a"/><path d="m276 267.684c0-49.41 37.312-90.263 85.799-96.93-4.565-.628-9.228-.96-13.97-.96h-14.03c-55.102 0-99.769 43.827-99.769 97.89v92.997h41.97z" fill="#e7b700"/><path d="m227.372 435.694c-1.183-2.251-.989-4.963.505-7.028l48.141-67.986h-41.988l-48.141 67.986c-1.494 2.065-1.688 4.776-.505 7.028 1.186 2.251 3.552 3.665 6.133 3.665h41.987c-2.58 0-4.946-1.413-6.132-3.665z" fill="#f9c500"/><ellipse cx="444.082" cy="223.072" fill="#d73131" rx="60.418" ry="60.92"/><path d="m418.346 243.106c-2.453-.257-4.731-1.705-5.924-4.072-1.79-3.551-.485-7.842 2.894-9.831-.2-2.018-.315-4.061-.315-6.132s.115-4.114.315-6.132c-3.379-1.988-4.683-6.279-2.893-9.83 1.193-2.367 3.472-3.822 5.926-4.079 6.534-18.91 22.053-33.573 41.402-38.799-4.999-1.35-10.248-2.081-15.668-2.081-33.369 0-60.418 27.274-60.418 60.92 0 33.645 27.049 60.92 60.418 60.92 5.42 0 10.669-.731 15.668-2.081-19.352-5.224-34.873-19.89-41.405-38.803z" fill="#a62b2b"/><path d="m69.721 30.979h180.531c4.513 0 8.205 3.655 8.205 8.121v116.118c0 4.466-3.692 8.12-8.205 8.12h-26.938v32.044c0 4.466-2.611 5.535-5.803 2.378l-34.785-34.421h-113.005c-4.513 0-8.206-3.654-8.206-8.12v-116.119c0-4.466 3.693-8.121 8.206-8.121z" fill="#0592fb"/><path d="m93 155.217v-116.117c0-4.466 3.693-8.121 8.206-8.121h-31.485c-4.513 0-8.206 3.655-8.206 8.121v116.118c0 4.466 3.693 8.12 8.206 8.12h31.485c-4.513-.001-8.206-3.654-8.206-8.121z" fill="#0181fb"/><path d="m455.098 358.294v-67.715c32.228-5.32 56.902-33.559 56.902-67.507 0-37.727-30.468-68.42-67.918-68.42-18.342 0-34.997 7.375-47.229 19.319-6.816-3.456-14.056-6.21-21.62-8.176v-10.071c0-15.023-12.393-27.245-27.625-27.245h-13.585c-15.232 0-27.625 12.222-27.625 27.245v10.06c-33.941 8.817-61.345 33.605-73.329 65.652h-219.622c-7.415 0-13.447 6.055-13.447 13.497v130.116c0 7.442 6.032 13.497 13.447 13.497h20.453v36.09c0 5.47 3.251 10.361 8.284 12.462 1.646.687 3.383 1.035 5.163 1.035 3.606 0 6.992-1.413 9.532-3.975l45.236-45.612h102.995l-25.296 35.724c-3.181 4.397-3.591 10.11-1.065 14.92 2.492 4.73 7.385 7.669 12.769 7.669h100.069c4.095 23.636 24.604 41.662 49.228 41.662 24.623 0 45.132-18.026 49.227-41.662h100.069c5.387 0 10.28-2.94 12.769-7.672 2.527-4.8 2.119-10.516-1.02-14.855zm-11.016-188.642c29.179 0 52.918 23.964 52.918 53.42s-23.739 53.42-52.918 53.42-52.918-23.964-52.918-53.42 23.739-53.42 52.918-53.42zm-122.685-13.928c0-6.752 5.664-12.245 12.625-12.245h13.585c6.961 0 12.625 5.493 12.625 12.245v7.284c-4.071-.463-8.208-.714-12.403-.714h-14.03c-4.195 0-8.331.246-12.402.708zm-222.407 217.822c-2 0-3.917.799-5.325 2.219l-44.765 45.136v-39.855c0-4.142-3.358-7.5-7.5-7.5h-26.4v-127.11h213.721c-1.436 6.865-2.191 13.971-2.191 21.247v11.61h-84.53c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h84.53v23.38h-170.26c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h170.26v25.62l-10.8 15.252h-116.74zm241.825 99.975c-16.326 0-30.06-11.359-33.9-26.662h67.799c-3.839 15.303-17.573 26.662-33.899 26.662zm-147.996-41.662 45.09-63.679h138.091c4.142 0 7.5-3.358 7.5-7.5s-3.358-7.5-7.5-7.5h-134.47v-85.497c0-49.841 41.392-90.39 92.269-90.39h14.03c14.038 0 27.348 3.098 39.272 8.615-6.907 10.71-10.937 23.468-10.937 37.163 0 36.379 28.332 66.207 63.934 68.293v61.815h-28.098c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h31.719l45.091 63.679h-295.991z"/><path d="m412.421 239.035c1.319 2.616 3.961 4.125 6.703 4.125 1.135 0 2.288-.259 3.371-.804l14.088-7.103v12.99c0 4.142 3.358 7.5 7.5 7.5s7.5-3.358 7.5-7.5v-12.99l14.087 7.102c1.083.546 2.235.804 3.371.804 2.742 0 5.384-1.509 6.703-4.125 1.864-3.699.378-8.209-3.321-10.074l-11.68-5.889 11.68-5.888c3.699-1.865 5.185-6.375 3.321-10.074-1.865-3.699-6.375-5.185-10.074-3.321l-14.087 7.102v-12.99c0-4.142-3.358-7.5-7.5-7.5s-7.5 3.358-7.5 7.5v12.991l-14.088-7.103c-3.698-1.865-8.209-.378-10.074 3.321-1.864 3.699-.378 8.209 3.321 10.074l11.68 5.888-11.68 5.889c-3.699 1.866-5.185 6.376-3.321 10.075z"/><path d="m56.27 294.293h49.958c4.142 0 7.5-3.358 7.5-7.5s-3.358-7.5-7.5-7.5h-49.958c-4.142 0-7.5 3.358-7.5 7.5s3.357 7.5 7.5 7.5z"/><path d="m69.721 170.837h109.922l32.594 32.253c3.175 3.142 6.219 3.984 8.57 3.984 1.628 0 2.925-.404 3.703-.729 1.896-.791 6.305-3.443 6.305-10.964v-24.544h19.438c8.66 0 15.705-7.007 15.705-15.62v-61.217c0-4.142-3.358-7.5-7.5-7.5s-7.5 3.358-7.5 7.5v61.217c0 .293-.302.62-.705.62h-26.938c-4.142 0-7.5 3.358-7.5 7.5v22.19l-27.813-27.521c-1.404-1.39-3.3-2.169-5.275-2.169h-113.006c-.404 0-.706-.327-.706-.62v-116.117c0-.293.302-.621.706-.621h180.531c.403 0 .705.328.705.621v19.9c0 4.142 3.358 7.5 7.5 7.5s7.5-3.358 7.5-7.5v-19.9c0-8.613-7.045-15.621-15.705-15.621h-180.531c-8.66 0-15.706 7.007-15.706 15.621v116.118c0 8.612 7.046 15.619 15.706 15.619z"/><path d="m217.051 62.131h-114.131c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h114.131c4.142 0 7.5-3.358 7.5-7.5s-3.358-7.5-7.5-7.5z"/><path d="m217.051 91.479h-114.131c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h114.131c4.142 0 7.5-3.358 7.5-7.5s-3.358-7.5-7.5-7.5z"/><path d="m217.051 120.827h-114.131c-4.142 0-7.5 3.358-7.5 7.5s3.358 7.5 7.5 7.5h114.131c4.142 0 7.5-3.358 7.5-7.5s-3.358-7.5-7.5-7.5z"/></svg>"
}

Подключение плагина к интерфейсу

Подключение плагина к интерфейсу происходит в Панели управления, раздел Интеграция / Плагины

После активации плагина требуется обновить окно браузера. Если у плагина есть веб-интерфейс, то доступ к нему будет доступен в верхнем меню системы в разделе "Сервисы" / "Дополнения":

Важно

index.php в папке с плагином всегда используется для интерфейса настроек