UKG Ready – How do I connect via API?
Updated last month
This guide explains how to create a connector with UKG Ready.
Start by opening the magic link provided. A pop-up window will appear.
Step 1: Click on Allow and Continue.
Next, the system will ask for a UKG Ready Domain Name.
Step 2: Navigate to the UKG Ready website.
Step 3: Click on the URLs tab.
Step 4: Select the section just before the "ta" and after "https://", copy it, and paste it in the provided prompt.
Step 5: Click on Connect.
The system will then ask for a UKG Ready Company Short Name.
Retrieving the UKG Ready Company Short Name
Step 1: Go to the UKG Ready website.
Step 2: Navigate to Settings > Global Setup > Company Setup from the menu on the top left.
This will open the UKG Ready company setup.
Step 3: Click on Company Info tab to open the company info section.
Step 4: Scroll down to the company address section and copy the company short name.
Step 5: Paste the company short in the provided prompt.
Step 6: Click on Connect.
The system will now ask for the UKG Ready API key.
Retrieving the UKG Ready API Key
Step 1: Go to the UKG Ready website.
Step 2: Navigate to Settings > Global Setup > Company Setup from the top left menu.
This will open the company settings.
Step 3: Click on Login Config tab.
Step 4: Scroll down to the API key section.
Step 4.a: If there is no key, you can click generate to create one. Continue to step 5.
Step 4.b: If there are existing integrations using this key, DO NOT click on generate. Simply copy the existing API key. Continue to Step 6.
Step 5: Click on Yes to generate a new API key.
Step 6: Click on the "eye" symbol, copy the API key, and paste it in the provided prompt.
Step 7: Click on Connect.
The system will now ask for the UKG Ready API user credentials.
Retrieving the UKG Ready API User Credentials
Step 1: Go to the UKG Ready website.
Step 2: Navigate to Settings > Profiles/Policies > Security.
A new security profile needs to be created.
Step 3: Click on New Security Profile and enter an appropriate security profile name.
Step 4: Provide appropriate access by selecting the following options.
Under Global Tab
Locate Global Setup. Give View access to Company EINs, Cost Center Definitions and Leave of Absence Custom Fields Definitions.
Locate Object Lists. Give View access to Company EINs, Cost Centers, Leave of Absence Categories, and Pay Period Profile.
Under Payroll Tab
Locate the Payroll section. Click Create/Edit Payroll and View/Edit/Add near payroll adjustment
Check Payroll Prep Process
Under HR Tab
Locate Employee, Base Compensation. Give them View access from the drop-down menu.
Locate Benefit Management (Plans). Give it View access.
Locate Cost Centers. Give it View access.
Locate Total Compensation. Give it View access.
Under Leave of Absence Management near the bottom, select Manage Requests.
Under Modules Tab
Go to Rest API Resources. Check the Employee Demographics, Employee HR Custom Fields, Employee Profiles, Employee Pay Information, and Employees
A new service account needs to be created.
Step 5: Navigate to Settings > Global Setup > Company Setup.
Step 6: Go to the Edit Tabs and Available Windows.
Step 7: Select Service Accounts and drag and drop it to the top.
Step 8: Click on Save.
Step 9: Go back to Login Config and add a new service account with appropriate credentials.
Step 10: Select the security profile created earlier.
Step 11: Go to Account Access, click the magnifying glass for Account Groups and select group with Group Name All Company Employees, and click on Save.
Step 12: Add your credentials in the provided section.
Step 13: Click on Connect.
A successful connection will be established.