API and Developer Tools Overview
The following overview provides a high level looks at the APIs and developer tools available with the UKG Pro HCM API (which leverages human resources data stored within the UKG Pro HCM system) and UKG Pro WFM API (which leverages the workforce management data stored within the UKG Pro WFM system).
API and Developer Tools Overview
The following overview provides a high level looks at the APIs and developer tools available with the UKG Pro HCM API (which leverages human resources data stored within the UKG Pro HCM system) and UKG Pro WFM API (which leverages the workforce management data stored within the UKG Pro WFM system).
This overview contains the following topics:
UKG Pro API
The UKG Pro API enables you to resolve integration needs by providing a programmatic interface to your UKG Pro data via SOAP-based and REST-based web services. The API enables the integration of UKG Pro HCM data in a variety of use cases from API dashboards to data replication and custom reporting front-ends.
The API supports the retrieval and updating of UKG Pro data. You can use a user name and password for a UKG Pro Service Account or a UKG Pro Web User account with Web Services permissions. Service Accounts can be granted permission to any of our web services on the Service Account administrative page in UKG Pro. Authentication also requires a valid Customer API key and User API Key.
UKG Pro REST API Domain Library
| Domain | Description |
|---|---|
| Audit | The Audit domain enables data auditing |
| Configuration Setup | The Configuration Setup domain enables configuration setup |
| Onboarding | The Onboarding domain enables employee onboarding |
| Payroll | The Payroll domain enables the processing of employee payroll |
| PRO Platform Configuration | The PRO Platform Configuration domain is used to configure platforms within UKG Pro HCM |
| PRO Security | The PRO Security domain is used to implement system security |
| PRO Employee Data | The PRO Employee Data domain is used to manage employee data |
| PRO Import Tools | The PRO Import Tools domain is used to manage available Import Tools |
| Recruiting | The Recruiting domain is used for recruiting prospective employees |
| UTA | The UTA domain is used to manage time and attendance related data |
UKG Pro SOAP Service API Domain Library
| Service | Description |
|---|---|
| Employee Employment Information Service | The Employee Employment Information Service allows users to leverage data for solving business application and integration needs. |
| Employee Job Service | The Employee Job Service enables the user to programmatically retrieve and update Employee Employment Information. |
| Employee New Hire Service | The Employee New Hire Service enables the user to programmatically hire an employee into a UKG Pro company based in the United States. |
| Employee Contacts Service | The Employee Contacts Service API enables the user to programmatically retrieve and update employee contact information. |
| Employee User Defined Fields Service | The Employee User Defined Field service enables users to leverage user defined fields. |
| Federated Single Sign-on User Service | The Federated Single Sign-on User Service enables users to use federated SSO. |
| Development Opportunity Service | The Development Opportunity Service enables users to programmatically retrieve and update Development Opportunity information. |
| Employee Compensation Service | The Employee Compensation Service enables users to programmatically retrieve and update employee compensation information. |
| Global Employee New Hire Service | The Global Employee New Hire Service enables users to programatically retrieve and update global employee new hires. |
| Employee Termination Service | The Employee Termination Service enables users to programmatically retrieve and update Employee Termination information |
| Employee Phone Service | The Employee Employment Information Service allows users to leverage data for solving business application and integration needs. |
| Deveopment Opportunity Participation Service | The Deveopment Opportunity Participation Service enables the user to programmatically retrieve and update Development Opportunity Participation information. |
| Development Opportunity Session Service | The Development Opportunity Session Service enables the user to programmatically retrieve and update Development Opportunity Session information. |
| Login Service | The Login Service enables the user to authenticate their UKG Pro credentials in order to retrieve an authentication token. |
| Employee Pay Statement Service | The Employee Pay Statement Service enables the user to programmatically retrieve the last employee pay statement information or a range of pay statements. |
| Time Management Web Services | Time Management Web Services enables users to programmatically retrieve time-related data from Time Management. |
| Employee Person Service | The Employee Person Service enables the user to programmatically retrieve and update employee person information. |
| Time and Attendance Service | The Time and Attendance Service enables other software to retrieve and update information in UKG Pro Time and Attendance. |
| Reports As A Service | The Reports As A Service enables customers to feed integration needs by providing a programmatic interface to your UKG Pro People Analytics Reports via a SOAP-based web service. By leveraging the integration between UKG Pro and Cognos, the API enables the integration of UKG Pro data in a variety of use cases from KPI dashboards and mashups to data replication and a custom reporting front-end. |
| Employee Address Service | The Employee Address Service enables the user to programmatically retrieve and update employee address information. |
| Canadian New Hire Service | The Canadian New Hire Service enables the user to programmatically retrieve and update Canadian New Hire information. |
Additional UKG Pro API Reference Material
- To view more information on UKG Pro APIs (including Service Accounts and Authentication, REST API specifications, and SOAP Service turorials), click Here
- To view a Quick Start guide for UKG Pro APIs, click here
- To learn about UKG Authentication, click here
UKG Pro WFM API
The following is a library of REST API Domains available for use within UKG Pro WFM.
UKG Pro WFM REST API Domain Library
| Domain | Description |
|---|---|
| Activities | The Activities domain enables users to monitor and react to progress on production, grant, or project work by tracking your employees, capital assets, and materials. Activities provides real-time information to improve decision-making about how to best use your workforce and resources. |
| Attendance | The Attendance domain automates the process of tracking and enforcing the types of policies that might typically be found in an employee handbook. Missing a punch, being absent, punching in or out too early or too late, or consistently taking longer breaks than allowed are all common examples of the types of employee policies Attendance can be configured to support. |
| Business Structure | The Business Structures domain enables you to define a hierarchical structure for your organization using types, locations, and jobs. |
| Common Resources I | Common Resources is the largest single domain and consists of two groupings. Common Resources are shared by all domains, allowing you to access and manipulate general employee data, user display profiles, business structures, the Control Center, the Transaction Assistant, and data aggregated across domains. |
| Common Resources II | Common Resources is the largest single domain and consists of two groupings. Common Resources are shared by all domains, allowing you to access and manipulate general employee data, user display profiles, business structures, the Control Center, the Transaction Assistant, and data aggregated across domains. |
| Employee Self-Service | Employee Self-Service (ESS) for Scheduling automates schedule processes to collect employee input, and reduces the time spent by managers in sorting, correcting, and posting final schedules. Employees use the features to request changes to their current schedules. |
| Forecasting Setup | Forecasting Setup allows you to access and configure Forecasting entities. |
| Forecasting | Forecasting allows you to provision and run forecasting operations, which provide the ability to view and modify volume forecasts and labor forecasts that the Scheduler uses to create schedules. |
| Healthcare Productivity | The Healthcare Productivity domain allows managers to analyze payroll, volume, and daily labor data so that they can make informed budget and schedule decisions based on metrics for the actual volume, the core scheduling plan, and staffing decisions. Previously, Healthcare Productivity (HCP) was called Healthcare Analytics (HCA). |
| Human Capital Management | Human Capital Management enables authorized users to access a variety of labor tracking needs, such as attendance management, employee scheduling, project tracking, benefit entitlements, and payroll preparation. |
| Information Access | The Information Access domain provides programmatic access to data from various sources in a manner similar to the way a database is accessed. The resources within this domain allow ad hoc queries, dynamic definition and execution of data views, and access to a data dictionary. |
| Leave | The Leave domain interacts with data from Timekeeping and Scheduling as part of its ability to administer and enforce leave policies. |
| People | The People Information domain provides API resources that allow you to create and configure employee information records. People Information governs each employee's work environment, including access profiles, pay and accrual rules, scheduling, and so forth. |
| Person Assignments | The Person assignments domain allows you to make assignments of system entities for one or more persons. |
| Platform | Platform comprises API resources with supporting capabilities that are neutral to Workforce Management concepts. |
| Scheduling Setup | Scheduling Setup allows you to access and configure Scheduling entities. |
| Scheduling | The Scheduling domain enables the management of employees' time, with links to other parts of the system, notably Timekeeping, People, payroll, and accruals. |
| Timekeeping Bulk Operations | Timekeeping Bulk Operations allows you to access and perform large-scale operations against Timekeeping resources. |
| Timekeeping Timecards | This domain allows you to access and configure Timekeeping timecards, which allow employees to enter their time, confirm the accuracy of work records, confirm that no unauthorized edits were made, and, in some cases, correct exceptions. |
| Timekeeping | The Timekeeping domain automates the collection, management, and distribution of employee hours. It allows organizations to configure business rules for managing employee time, and also allows organizations to schedule employees and manage accruals and vacation time. |
| Universal Device Manager | The Universal Device Manager (UDM) domain enables the flow of employee data between the Timekeeping system and data collection devices. |
Integration Tools
UKG Pro Integrations Dashboard
The Integrations Dashboard enables you to run and view the results of integrations between UKG Pro products and other business partners.
- To access the Integration Dashboard, click here
UKG Pro WFM Integrations Hub (iHub)
Integration Hub exchanges and maps data between UKG Pro WFM and other applications in a cloud-computing environment. It supports multiple tenants and requires no customer installation of additional software, hardware, or network infrastructure. You can run integrations on-demand or on a schedule.
Use Integrations to:
- Fetch data directly, by APIs, or from flat files.
- Map and transform the data as needed.
- Move the data to the destination file or application.
For more information about iHub, click here
UKG Pro WFM Turnkey Integration Platform (TIP)
Note: At this time, access to the Turnkey Integration Platform (TIP) dashboard is available only for Services and support users.
On the Turnkey Integration Platform (TIP) dashboard, you can configure and edit integration instances. Within the grid of integrations, you can select an integration and perform actions such as editing or deleting an integration.
For more information about the Turnkey Integration Platform, click here.
Updated about 2 months ago