Welcome to the UKG Developer Hub
As a developer, you know that APIs are the building blocks of modern applications, and our platform is designed to empower you to create amazing experiences.
Whether you're a seasoned developer or just starting out, our Developer Hub provides the resources and tools you need to get up and running quickly. With comprehensive documentation, step-by-step tutorials, and a complete specification covering the entire breadth of the API, our platform is the perfect place to discover, learn, and create. Come explore our API and see what amazing apps you can build!
Each project within the hub contains an API specification and writer-crafted guidance. 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.
Overview
The Developer Hub consists of a landing page and multiple projects.
Landing page
The landing page allows you to easily navigate to UKG product-specific API projects, access What's New content, and search across the entire Developer Hub.
Projects
The Developer Hub organizes the information developers need to build applications into logical groups called projects. A project usually covers a product-specific API but can contain more general content. There are currently three projects in the Developer Hub:
- Developer Hub Topics: General news and information relevant to the whole Developer Hub
- UKG Pro Workforce Management: API specifications and crafted documentation for Pro Workforce Management
- UKG Pro: API specifications and crafted documentation for Pro
Note: The landing page also provides links to UKG Ready and HR Service Delivery API content.
API specification
Reference documentation describes each API in detail, down to each operation's request and response properties. Reference documentation is accessed by selecting an API project on the Developer Hub landing page and by the persistent API Specifications link in the header of each API project. This area of the Developer Hub houses our library of API resources, organized hierarchically by API resource and all available operations against each resource.
- An API resource represents a business entity that is stored or computed.
- An API operation consists of an HTTP method plus a URL.
Crafted documentation
| Category | Description |
|---|---|
| Quick Start | For those who want to hit the ground running, a self-contained guide to get you using the API quickly |
| Authentication | Topics on different ways to authenticate |
| Important Notes | News, important release-specific notes, and the version history |
| API Essentials | Essential topics for understanding the API, including status codes, service limits, deprecation policy, and so on |
| Best Practices | Specific tips, tricks, and best practices |
| Tutorials | Specific process and general concept examples |
| Example Library | Request and response examples for different operations |
Updated 8 months ago