Для начала работы с API нужно сгенерировать API ключ. Это можно сделать в Настройках -> Ключи API (в разделе "Безопасность") -> Сгенерировать.

Если вы хотите создавать/редактировать компенсации сотрудников через API - предоставьте соответствующее разрешение в окне генерации ключа.

API PeopleForce имеет ограничение в количестве запросов в минуту. Ознакомиться с текущими требованиями перейдите по ссылке. Учитывайте это ограничение во избежание ошибок.

Все ресурсы, возвращающие список записей, имеют унифицированную пагинацию. Ознакомиться с форматом можно перейдя по следующей ссылке.

Для удобства работы с API можно импортировать конфигурацию OpenAPI в Postman или другой HTTP клиент.

Посмотреть пример ответа от API по каждому эндпоинту можно в соответствующем блоке:

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

Пользовательские (дополнительные) поля можно добавить через настройки. Более подробно ознакомиться здесь .

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

1. Создание/обновление/получение департаментов

2. Создание/обновление/получение подразделений

3. Создание/получение локаций

4. Создание/обновление/получение должностей

5. Создание/обновление/получение видов занятости

6. Создание/обновление/получение графиков работы

Создание базы текущих сотрудников с необходимыми полями из личной информации, рабочей информации и тд. После создания учетной записи, чтобы отобразить данные о должности, заработной плате и занятости, а особенно хронологию изменений, необходимо дополнительно внести эти данные, обращаясь к точкам ниже (пункты 2-4).

1. Создание профиля сотру сотрудника

2. Добавление записи о занятости

3. Добавление записи о должности

4. Добавление записи о компенсации

5. Создание/получение задач по сотруднику

6. Создание документа по сотруднику

Также с помощью синхронизации вы можете обновлять информацию по сотруднику в PeopleForce или увольнять его в системе.

Дополнительно вы можете переносить другую информацию по сотруднику, которая не указана в этом списке. Больше действия доступны и прописаны в документации.

Перед настройкой этого вида интеграции убедитесь, что типы отсутствий и политики созданы в системе и назначены на сотрудников. Если с этим возникают вопросы - обратитесь, пожалуйста, к вашему CS менеджеру.

Передача данных из PeopleForce в 1С:

Получение списка всех запросов на отпуск по компании

Запросы можно фильтровать по датам, сотрудникам, статусам и т.д. передавая соответствующие параметры.

Передача данных из 1С в PeopleForce:

Перед созданием запросов сотрудники уже имеют

Создание нового запроса

Среди обязательных параметров для создания запроса на отпуск есть тип отпуска - leave_type_id. Для его получения используйте эндпоинт

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

Создание актива и назначение актива на сотрудника

Эндпоинты для работы с активами и их назначением

Дополнительно: Вебхуки для получения изменений от PeopleForce в реальном времени

Вебхуки позволяют получать все изменения в PeopleForce без необходимости запрашивать их отдельно. Например, при изменении каких-либо полей в профиле сотрудника мы отправим соответствующий ивент, где будет актуальная информация по сотруднику.

Добавление нового вебхука

Список всех вебхуков

Для получения детальной информации о вебхуке, а также пример данных, выберите нужный вебхук в навигационном меню слева: