Klucz API Konta serwisowego umożliwia połączenie zewnętrznych usług z PeopleForce przy jednoczesnej kontroli dostępu do danych użytkowników i działań na poziomie organizacji. W przeciwieństwie do klucza API Organizacji, dostęp Konta serwisowego jest zarządzany za pomocą roli utworzonej w sekcji Grupy uprawnień.
🔑 Wygeneruj klucz API konta serwisowego
Przejdź do Ustawienia → Klucze API.
Kliknij + Nowy.
Wprowadź nazwę klucza.
W polu Typ wybierz Konto serwisowe.
W razie potrzeby podaj adresy IP, z których będzie można korzystać z klucza.
Kliknij Wygeneruj. Skopiuj wygenerowany klucz API i zapisz go w bezpiecznym miejscu. Ze względów bezpieczeństwa PeopleForce nie wyświetli ponownie pełnego klucza po jego wygenerowaniu.
💡 Jeśli Konto serwisowe nie jest dostępne jako typ klucza API, skontaktuj się z support@peopleforce.io, aby włączyć tę funkcję.
👤 Utwórz rolę konta serwisowego
Po wygenerowaniu klucza utwórz rolę, która określi jego dostęp.
Przejdź do Ustawienia → Grupy uprawnień.
Kliknij Nowe i wybierz Konto serwisowe.
Wprowadź nazwę roli i opcjonalnie opis.
W sekcji Kto jest przypisany do tej roli? wybierz utworzony klucz API Konta serwisowego.
Następnie skonfiguruj uprawnienia tej roli, aby określić, do czego Konto serwisowe będzie miało dostęp przez API.
🔐 Skonfiguruj dostęp do danych użytkowników
Otwórz kartę Użytkownicy, aby określić, do których użytkowników i informacji Konto serwisowe ma mieć dostęp.
W sekcji Do czyich danych użytkownicy mają dostęp? wybierz użytkowników, których dane powinny być dostępne:
Określone osoby – użyj warunków, aby określić, do których użytkowników Konto serwisowe ma mieć dostęp.
Wszyscy – zezwól na dostęp do wszystkich użytkowników.
Możesz również wybrać opcję Uwzględnić użytkowników z zakończoną współpracą.
Następnie skonfiguruj uprawnienia do wymaganych danych użytkowników. W zależności od uprawnienia możesz wybrać:
Brak – brak dostępu;
Widok – dostęp do odczytu;
Edycja – możliwość wprowadzania zmian.
Jeśli rola nie obejmuje danego użytkownika, nie zostanie on zwrócony przez API. Jeśli rola nie ma dostępu do określonego pola, pole to nie pojawi się w odpowiedzi API.
🏢 Skonfiguruj uprawnienia organizacji
Użyj karty Organizacja, aby przyznać dostęp do funkcji na poziomie całej organizacji.
Włącz wymagane uprawnienia do zarządzania w zależności od działań, które ma wykonywać integracja, na przykład podczas pracy z danymi całej organizacji, takimi jak działy lub lokalizacje.
Przyznaj tylko te uprawnienia, które są niezbędne dla integracji.
🔌 Użyj klucza z API v4
Klucze Konta serwisowego są używane z PeopleForce API v4.
Przekaż wygenerowany klucz w nagłówku żądania:
X-API-KEY
API v4 nie obejmuje obecnie wszystkich endpointów dostępnych w API v3. Przed skonfigurowaniem integracji sprawdź, czy wymagane endpointy są dostępne w dokumentacji API v4.
📚 Więcej informacji o uwierzytelnianiu znajdziesz w sekcji Uwierzytelnianie API v4.