Skip to main content
UKG Ready

API key authentication using UKG Ready- setting up UKG Ready domain, short company name, API User Account, and permissions.

Updated over 6 months ago

HRIS Integrations is only available for Elevated or Enterprise accounts


โ€‹Step One: Enter your Domain in Snappy

For example, if you sign in at "acme.com/ta/Default.login", enter "acme.com".


โ€‹


Step Two: Find your Company Short Name

1.) Log into your UKG Ready account and open the menu in the upper left. Go to your settings icon, and click on Global Setup followed by Company Setup.

2.) Open Company Info.

3.) Scroll down to find Company Short Name under Company Address. Copy your Company Short Name.

4.) Paste you Company Short Name in Snappy and click Submit.


Step Three: Find your UKG Ready API Key

1.) In your Company Setup page, go to Login Config.

2.) Scroll to find API Keys and click the eye icon to reveal the key. Copy the API Key and store it in a secure place.

** If there is no key you can click generate to create one, but if there are existing integrations using this key DO NOT click generate.

3.) Paste your API Key in Snappy and press submit.


Step Four: Creating the Security Profile

1.) In your menu on the left, go to Settings, Profiles/Policies, and then Security. Click NEW SECURITY PROFILE on the upper right hand side.

2.) In this profile, we want to make sure all relevant permissions are enabled for the following endpoints:

  • In your HR Tab:

    • Find Cost Centers. Select View.

  • In your Modules tab:

    • Scroll to Rest API Resources. Select Employee Demographics, Employee HR Custom Fields, Employee Profiles, and Employees.

  • In your Global tab (if applicable):

    • In Global Setup, find Company EINs and Cost Center Definitions.

Step Five: Creating your Service Account

1.) From Settings -> Global Setup -> Company Setup go to Edit Tabs.

2.) From the Available Windows box on the right side of the screen, scroll down to Service Accounts. Drag it to the Top section in the middle. Click Save.

3.) Click Add Service Account. Enter a new username and password of your choice to create a new account. Enter the Security Profile you created. Click the magnifying glass for Account Groups and select All Company Employees.


Step Six: Add your Service Account to Snappy

Type in your Service Account User ID and Password to complete the linking flow.

Did this answer your question?