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.