Шаблоны API

Общая информация

Модуль API может быть полезен, когда необходимо выгрузить данные из программы на сторонний сайт или в другую программу.

Начало работы с модулем

Для начала работы с модулем перейдите в «Настройки» – «Модули».

photo photo

В открывшемся окне нажмите на модуль API.

photo

Сразу стоит заметить, что модуль может работать в двух режимах – платном и бесплатном.

В бесплатном режиме допускается добавление 1 шаблона и не более 10 запросов в сутки. При этом в случае добавления нового шаблона новые запросы в эти сутки произвести не получится.

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

Шаблоны

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

photo

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

photo

После нажатия на кнопку «Добавить шаблон» необходимо будет заполнить настройки шаблона. А именно:

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

photo

При выборе типа «Полный» станут доступны еще 4 настройки:
Просмотр записи – определяет возможность просмотра данных, выведенных через API на сайте.
Добавить запись – определяет возможность добавления новых записей через API в CRM.
Редактировать – определяет возможность редактирования данных, выведенных через API на сайте.
Быстрый поиск – определяет возможность поиска по данным, выведенным через API на сайте. Особенно будет полезно, если планируется выводить большое количество данных.

photo

После нажатия на кнопку «Сгенерировать» в окне ниже будет сформирован код, который вы сможете разместить на своем сайте. Также необходимо будет сохранить созданный шаблон, нажав на соответствующую кнопку.Чуть ниже кода для размещения на сайте будет показано превью, в каком виде данные будут выведены на сайте. Изменить перечень полей для вывода можно, настроив группу доступа, к которой относится пользователь и/или настроив фильтр, по которому выводятся данные.

photo



+ сегодня

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

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

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