This article will discuss configuring the UKG API within detamoov as a Premier Integration.  To activate the UKG Premier Integration on your detamoov account, please first contact us at [email protected].

 

Within this article we'll discuss:

 

1. Creating a service account username, password and API key for detamoov within UKG
2. Creating a company group within UKG that that detamoov service account can access
3. Configuring the UKG premier integration within detamoov

Creating a service account username, password and API key for detamoov within UKG

Within UKG, follow these steps to create your detamoov service account username, password and API key.

 

If you want to allow access to all companies, follow the step below.  If you need to create a Custom Group, first go to the Creating a company group within UKG that that detamoov service account can access section.

 

Service Account Setup

 

1. Login to UKG
2. Search for your Company Type ADMIN company
3. Go to Edit Company icon
4. Go to Edit Tabs on the top
5. Find and move "Service Accounts" to the top
6. Click Save and then click the Back arrow
7. Click Add Service Account
8. Enter a username
9. Enter a password
10. Select Admin Security Profile
11. Category = Not Defined
12. Type = Not Defined
13. Under Company Access check Login As Account
14. Under Company Access check Login As SA
15. Under Company Groups, either choose All Companies, or set up Custom Group (see below for Custom Group Setup).
16. Under Account Access check Edit
17. In Account Groups select All Accounts
18. Click Save

 

 

 

Generate Admin Company API Key

 

1. In UKG click on the menu in the upper left
2. Click the Gear icon
3. Select Maintenance > Admin Company > Company Configuration
   
   
    
4. Scroll down to API Keys
5. If you already have an API key, click the Eye icon and copy the API Key.  If this is blank, Generate the API key and click Save.

 

If you selected All Companies in the Company Groups above, go to Configuring the UKG Premier Integration within detamoov section.

 

Creating a company group within UKG that the detamoov service account can access

 

Custom Group Setup

 

1. Login to UKG
2. Search for Company Groups
3. Click New Group
4. Filter Based
5. Set name field to detamoov
6. Delete "No Match"
7. Click Add then choose specific Companies
8. Click the Paper icon
9. Choose detamoov clients
10. Click Add Selected
11. Click User Filter
12. Click Save
13. Click View Group Permissions
14. Click Add Manager
    
    
     
15. Choose the detamoov account
16. Check off all 3 boxes
17. Click Save

Continue with Creating a service account username, password and API key for detamoov within UKG.

 

Configuring the UKG Premier Integration within detamoov

 

After detamoov has activated the UKG Premier Integration on your account and you have added the Service Account, access your detamoov account and enter in the username, password, API Key and Bureau Company Short Name.

 

1. Login to detamoov
2. Click Tools on the left
3. Click the Integration Services tab
4. Expand the Premier Integrations panel
5. Click Add
   
   
    
6. In the Premier Services dropdown, select UKG API
7. Enter a name in the Name field
8. Enter in the Base URL of: https://secure.saashr.com/ta/rest
9. Enter in the Username of your Service Account
10. Enter in the Password of your Service Account
11. Enter in your Bureau Company Short Name
12. Click Save Changes