Подключение к API начинается не с кода, а с двух настроек в кабинете: права на интеграцию и внешних идентификаторов у сотрудников. Без них запросы будут уходить впустую, а сотрудники — задваиваться.
Что понадобится
- Доступ в личный кабинет с правом «Редактирование доступа к кабинету».
- Разработчик на стороне внешней системы.
Порядок подключения
Шаг 1. Создайте в личном кабинете пользователя, от имени которого будет выполняться интеграция, и предоставьте ему право «Интеграция с внешними системами». Право выдаётся в карточке сотрудника в разделе «Права». Если вкладка недоступна, см. статью «В настройках нет вкладки «Интеграция с внешними системами»».
Шаг 2. Заполните поле «Внешний идентификатор» в карточках сотрудников — по нему сотрудник сопоставляется между Workpace и внешней системой.
Шаг 3. Разработайте интеграцию на стороне внешней системы, используя описание API. Описание предоставляется службой поддержки или вашим центром технического обслуживания (ЦТО).
Шаг 4. Проверьте интеграцию на тестовом контуре — см. статью «Тестовый контур для разработчика».
Доступные процессы
- создание и изменение данных по сотрудникам во внешней системе с передачей в Workpace;
- получение из Workpace данных по отработанным часам.
Как проверить, что получилось
Выполните тестовый запрос на тестовом контуре от имени созданного пользователя. Если право выдано корректно, данные по сотрудникам будут доступны.
Частые вопросы
Где взять описание API?
У службы поддержки или в своём ЦТО.
Нужен ли отдельный пользователь для интеграции?
Рекомендуется: авторизация выполняется от имени пользователя с правом «Интеграция с внешними системами».
Обязательно ли заполнять внешний идентификатор?
Да, если данные о сотрудниках приходят из внешней системы или уходят в неё.