Для початку роботи з API потрібно згенерувати API ключ. Це можна зробити в Налаштуваннях -> Ключі API (в розділі “Безпека”) -> Згенерувати.

Якщо ви бажаєте створювати/редагувати компенсації співробітників через API - надайте відповідний дозвіл у вікні генерації ключа.

API PeopleForce має обмеження в кількості запитів на хвилину. Ознайомитися з поточними вимогами можна на сторінці https://developer.peopleforce.io/docs/rate-limit. Враховуйте це обмеження щоб уникнути помилок.

Всі ресурси, що повертаюсь список записів, мають уніфіковану пагінацію. Ознайомитися з форматом можна на сторінці https://developer.peopleforce.io/docs/pagination.

Для зручності роботи з API можна імпортувати конфігурацію OpenAPI в Postman або інший HTTP клієнт - https://developer.peopleforce.io/openapi.

Переглянути приклад відповіді від API по кожному ендпоінту можна у відповідному блоці:

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

Користувацькі (додаткові) поля можна додати через налаштування. Більш детально тут https://help.peopleforce.io/uk/articles/6668096-додаткові-поля-в-картці-працівника

Нижче наведено список ендпоінтів, які можна використовувати для динамічного створення та отримання потрібних записів. При натисканні на посилання відкриється метод у документації.

1. Створення/оновлення/отримання департаментів

https://developer.peopleforce.io/reference-link/departments

2. Створення/оновлення/отримання підрозділів https://developer.peopleforce.io/reference/divisions

3. Створення/отримання локацій

https://developer.peopleforce.io/reference/locations

4. Створення/оновлення/отримання посад

https://developer.peopleforce.io/reference/positions

5. Створення/оновлення/отримання видів зайнятості

https://developer.peopleforce.io/reference/employment-types

6. Створення/оновлення/отримання графіків роботи

https://developer.peopleforce.io/reference/working-patterns

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

1. Створення профіля сотру співробітника

https://developer.peopleforce.io/reference/post-employees

2. Додавання запису про зайнятість

https://developer.peopleforce.io/reference/post-employees-id-employment_statuses

3. Додавання запису про посаду

https://developer.peopleforce.io/reference/post-employees-id-positions

4. Додавання запису про компенсацію

https://developer.peopleforce.io/reference/post-employees-id-salary

5. Створення/отримання задач по співробітнику

https://developer.peopleforce.io/reference/tasks

6. Створення документа по співробітнику

https://developer.peopleforce.io/reference/post-employee_documents

Також за допомогою синхронізації ви можете оновляти інформацію по співробітнику в PeopleForce:

https://developer.peopleforce.io/reference/put-employees-id

Або звільняти його в системі:

https://developer.peopleforce.io/reference/post-employees-id-terminate

Додатково ви можете переносити іншу інформацію по співробітнику, яка не вказана в цьому списку. Більше дії доступні та прописані в документації.

Перед налаштуванням цього виду інтеграції переконайтесь, що типи відсутностей та політики створені в системі та призначені на співробітників. Якщо з цим виникають питання - зверніться, будь ласка, до вашого CS менеджера.

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

Отримання списку всіх запитів на відпустку по компанії https://developer.peopleforce.io/reference/list-leave_requests

Запити можна фільтрувати по датам, співробітникам, статусам і т.д. передаючи відповідні параметри.

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

Перед створенням запитів співробітники вже мають

Створення нового запиту

https://developer.peopleforce.io/reference/create-leave_request

Серед обов’язкових параметрів для створення запиту на відпустку є тип відпустки - leave_type_id. Для його отримання використовуйте ендпоінт

https://developer.peopleforce.io/reference/get-leave_types

Звернуть увагу - запити, створені через API, мають погоджуватися так само, як і звичайні - через веб інтерфейс PeopleForce. Для одноразового додавання історичних даних використовуйте відовідний імпорт - https://help.peopleforce.io/uk/articles/6701523-імпорт-відсутностей

Створення активу та призначення активу на співробітника

Ендпоінти для роботи з активами і їх призначенням https://developer.peopleforce.io/reference/assets

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

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

Додавання дового вебхуку:

https://developer.peopleforce.io/docs/starting-with-webhooks

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

https://developer.peopleforce.io/docs/webhooks-1

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