Ключ API для акаунта сервісу дає змогу підключати зовнішні сервіси до PeopleForce і контролювати, до яких даних співробітників та дій на рівні компанії вони матимуть доступ через API. На відміну від ключа API типу Компанія, доступ для акаунта сервісу визначається окремою роллю в розділі Ролі та права доступу.
🔑 Згенеруйте ключ API для акаунта сервісу
Перейдіть до Налаштування → Ключі API.
Натисніть + Нове.
Введіть ім'я ключа.
У полі Тип виберіть Акаунт сервісу.
За потреби вкажіть IP-адреси, з яких можна використовувати ключ.
Натисніть Згенерувати. Скопіюйте згенерований ключ API та збережіть його в безпечному місці. З міркувань безпеки PeopleForce більше не відображатиме повний ключ після його створення.
💡 Якщо Акаунт сервісу недоступний як тип ключа API, зверніться до support@peopleforce.io, щоб увімкнути цю функцію.
👤 Створіть роль для акаунта сервісу
Після створення ключа створіть роль, яка визначатиме його доступ.
Перейдіть до Налаштування → Ролі та права доступу.
Натисніть Нова роль і виберіть Акаунт сервісу.
Введіть ім'я ролі та, за бажанням, опис.
У розділі Хто призначений на цю роль?, виберіть створений ключ API для акаунта сервісу.
Потім налаштуйте права доступу для цієї ролі, щоб визначити, до чого акаунт сервісу матиме доступ через API.
🔐 Налаштуйте доступ до даних співробітників
Відкрийте вкладку Люди, щоб визначити, до яких співробітників та інформації матиме доступ акаунт сервісу.
У розділі До чиїх даних учасники мають доступ? виберіть співробітників, дані яких мають бути доступні:
Конкретні люди – використовуйте умови, щоб визначити, до яких співробітників матиме доступ акаунт сервісу.
Усі – надайте доступ до всіх співробітників.
За потреби також виберіть Додати звільнених співробітників.
Далі налаштуйте права доступу до потрібних даних співробітників. Залежно від права доступу можна вибрати:
Немає – немає доступу;
Перегляд – доступ для перегляду;
Редагування – можливість вносити зміни.
Якщо роль не охоплює певного співробітника, його дані не повертатимуться через API. Якщо роль не має доступу до певного поля, це поле буде відсутнє у відповіді API.
🏢 Налаштуйте права доступу компанії
Використовуйте вкладку Компанія, щоб надати доступ до функцій на рівні компанії.
Увімкніть потрібні права для керування залежно від того, які дії має виконувати інтеграція, наприклад, під час роботи із загальними даними компанії, як-от департаменти або локації.
Надавайте лише ті права доступу, які потрібні для вашої інтеграції.
🔌 Використовуйте ключ з API v4
Ключі для акаунта сервісу використовуються з PeopleForce API v4.
Передавайте згенерований ключ у заголовку запиту:
X-API-KEY
API v4 наразі містить не всі ендпоїнти, доступні в API v3. Перед налаштуванням інтеграції перевірте, чи доступні потрібні ендпоїнти в довіднику API v4.
📚 Докладніше про автентифікацію читайте в розділі Автентифікація API v4.