The Developer Hub fully documents the UKG Pro Workforce Management API and is organized into reference and conceptual documentation, accessed through the API specifications and Documentation links in the header.
The complete API specification is available in the lefthand navigation menu adjacent to this page. Our crafted documentation provides everything from a quick start guide that launches you into making an API call to best practices and in-depth tutorials.
Documentation Table of Contents
| Developer Hub Category | Previous Location in legacy Developer Portal |
|---|---|
| Quick Start | Getting started > Make an API call |
| Authentication | Authentication |
| Important Notes | Important Notes |
| API Essentials | A combination of Getting started, Overview, and other essential topics |
| Best Practices | Best practices |
| Tutorials | Guides |
| Example Library | Examples |
The API Specification
The API specification describes the UKG Pro Workforce Management API in detail, down to each operation's request and response. Reference documentation is accessed through the persistent API specifications and Documentation links in the header of each page. This area of the Developer Hub houses our library of API resources, organized hierarchically by domain, or major functional area, API resource, and all available operations against each resource.
Structure
Each functional area within the suite is known as a domain. Every domain contains resources, each of which represents a business entity that is stored or computed.
- Stored entities include punches, accrual balances, and shifts
- Computed entities include the schedule and the Attendance processor
Every resource is accessed using one or more operations, each of which consists of an HTTP method plus a URL.
While most domains focus on a specific functional area, Common Resources and Platform do not.
The Common Resources domains contain resources 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.
The Platform domain contains resources with supporting capabilities that are neutral to workforce management concepts.
Crafted documentation
The conceptual documentation provides writer-crafted user guidance that introduces our API and provides a series of informative and tutorial topics to get you started with the API as quickly as possible. This area of the Developer Hub also provides overviews of our API, including our pragmatic implementation of the REST standard, and of our major domains.
Structure
The Foundations topic introduces the basic concepts undergirding our API and provides brief, useful introductions to CRUD operations, the basic flow of our calls, API resources, operations against those resources, authentication and security, app keys, versioning, errors and error handling, asynchronous requests, the internationalization and localization standards we employ, and our tracking, logging, and support strategy. The API Essentials category also explains the primary domains that comprise our suite, our particular implementation of the REST architectural style, and the structure and navigation of our Developer Hub.
Our collection of guides in the Tutorials category steps you through building some of our most popular features into your application. Each feature includes instructions for constructing valid requests and demonstrates example responses.