Шаблоны API

Использование шаблона API в CRM "Клиентская База"


 

Работа с модулем

CRM «Клиентская база» предоставляет возможность воспользоваться ее функционалом на вашем сайте через API (программный интерфейс приложения). Вы сможете взаимодействовать с таблицами практически так же, как и через CRM.
Рассмотрим пример использования шаблона API.
Для начала следует включить модуль API в настройках. Переходим в «Настройки», «Модули», выбираем модуль «API (1.0)».

zoom 

 

Включаем модуль, нажав на кнопку «Включить». Выбираем пользователя и добавляем его. На странице вы увидите табличку, которая отображает пользователя, группу его доступа и API AuthKey (уникальный ключ API, необходимый для его использования).

Важно! При отображении/редактировании/добавлении данных на сайте будут действовать права того пользователя, которого вы выберите! Внимательно выбирайте пользователя, его доступ, а также настройки по работе с шаблоном API. Если на сайте нужны уникальные настройки доступа, можно создать новую группу доступа и пользователя в этой группе.

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

zoom 

Нажмите кнопку «Сгенерировать». Сгенерируется код, который вам необходимо встроить в файл .php на хостинге.

zoom 

 

Нажав на кнопку «Показать шаблон», вы увидите внизу страницы, как будет выглядеть шаблон API на вашем сайте.

zoom

 

Создайте файл с расширением .php в удобном для вас каталоге хостинга или вашего локального сервера. Вставьте туда сгенерированный в шаблоне код. В нашем примере это kb_api.php.

zoom

Можно сделать на него ссылку на веб-странице вашего сайта или форума, если нужно просмотреть таблицу. Как вариант использования можно прислать кому-либо ссылку по почте, чтобы другой мог внести какие-то изменения в определенную таблицу, не видя всего остального. Например: https://mytesthomepage.ru/kb_api.php Перейдя по ссылке, вы получите возможность работать с таблицей под установленным ранее пользователем с выбранными правами. Тег для вставки в страницу будет иметь вид: Клиентская База — Товары для просмотра и добавления

zoom

 

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

Вставка кода шаблона в вашу страницу

Код шаблона состоит из двух частей: теги PHP, теги JS + CSS. Если вы планируете вставить код шаблона в страницу вашего сайта, то вам нужно будет выстроить код страницы определенным образом.

Порядок добавления шаблона в страницу будет выглядеть так:

1. Вставляется код PHP в начало страницы. В шаблоне он выделен тегами.

2. Вставляется основной код вашей страницы.

3. Вставляется оставшаяся часть шаблона — код JS+CSS, в ту часть основного кода страницы, где вы хотите увидеть информацию из таблицы CRM. Далее на скриншотах вы увидите, как это выглядит.

Код PHP. Для корректной работы код php из шаблона рекомендуется вставлять в начало страницы. Это обязательное условие - код должен запускаться до вывода чего-либо. Можно также сохранить php код в отдельный файл и подключать на страницу через include, чтобы не засорять ее.

zoom

 

zoom

 

Код JS+CSS. Оставшуюся часть шаблона, которая выделена прямоугольником на скриншоте,  вставляем в нужное нам место на странице - там будет выведен результат.

zoom

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

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

zoom

 

zoom

 

zoom

 

Требования к серверу

Требования к хостингу/локальному серверу сайта ограничиваются возможностью запуска кода php 5/7 версии с библиотекой curl.

 

Возможные проблемы

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

zoom

 

При возникновении проблем с правами доступа на локальном сервере, установки PHP обратитесь к документации установки ПО сервера/хостинга или его администратору.

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

 

Полезная документация.

https://clientbase.ru/help/for_admin_16/api/ - Документация по API

http://htmlbook.ruИнформация о HTML, PHP, стилях CSS




+ сегодня

компаний уже выбрали Клиентскую базу!
Узнайте, почему.

  • компания
  • компании
  • компаний
  • выбрала
  • выбрали
  • выбрали

Создайте собственный аккаунт прямо сейчас! Бесплатно! Начать бесплатно