Table of Contents |
---|
Общие положения
API серверов позволяет внешней системе запрашивать и отправлять данные в 1С-Коннект, а также осуществлять рассылки.
API серверов предоставляет возможность обмена данными на уровне серверов. Все действия при этом выполняются пользователем с правами администратора Личного кабинета 1С-Коннект.
В части оперирования данными 1С-Коннект, API серверов предназначен для синхронизации базы данных информационной системы клиента с "облаком" 1С-Коннект, в том числе в условиях больших объемов данных.
Info |
---|
API серверов обеспечивает передачу внешней системе списка измененных объектов данных с указанного момента времени, а не полного списка объектов. Это позволяет существенно экономить вычислительные ресурсы и сетевой трафик, но требует от внешней стороны вести учет меток актуальности данных 1С-Коннект. |
Основные возможности
API серверов поддерживает следующие действия с объектами системы 1С-Коннект:
Создание, изменение, удаление и выгрузку списков следующих видов объектов:
сотрудник своей организации;
клиент (юр.лицо);
сотрудник клиента;
линия поддержки;
компетенция сотрудника по линии;
подключение линии поддержки потребителю (сотруднику своей организации/ сотруднику клиента);
обращение по линии поддержки;
заявка на обслуживание.
Выгрузку истории коммуникации пользователей.
Получение статистики показов/просмотров по стартовым заставкам и продуктам витрины.
Создание, изменение и отправку рассылок и уведомлений пользователям.
Отправку сообщений и файлов в чат по линии поддержки.
Warning |
---|
Доступ к API серверов, а также настройка часового пояса, в соответствии с которым будет показана информация, полученная с помощью web-сервисов, настраиваются в Личном кабинете в разделе "Администрирование" подраздел "Настройки API". Также в этом подразделе вы можете посмотреть статистику по использованию web-сервисов. |
Реализация
API серверов основан на механизмах Web-сервисов в реализации "1С: Предприятие 8.3".
Все операции манипулирования данными сгруппированы по-объектно.
Добавление, изменение и удаление объектов определенного вида можно делать пакетно, т.е. "пачкой за 1 раз".
Все входные параметры вызова ws-операции передаются одной переменной-массивом (XDTO-совместимой с типом «Структура» прикладного языка "1С: Предприятие 8") - это позволяет впоследствии расширять перечень передаваемых параметров, сохраняя совместимость с ранее написанными клиентами внешними алгоритмами.
У всех ws-операций единая структура ответа, она позволяет при успехе выполнения передать результат, а при ошибке выполнения - сведения об ошибке и месте её возникновения.
Во избежание непреднамеренной DDoS-атаки путём беспрерывной бесконечной цепочки запросов к API, на каждый вид ws-операции наложено ограничение по максимальному количеству вызовов операции в час. Параметры ограничений указаны в таблице.
...
Обработка-пример вызова операции GetHistoryOfServiceCalls: ВызовОперацийPartnerAPI2.epf
Структура результата ws-операции
...