Data Integration and APIs
About ADP Human Capital Management (HCM) Platforms
ADP HCM Platforms provide APIs your application can leverage for data exchange. Popular platforms include the following:
- Run Powered by ADP is the small business platform HR and Payroll platforms and general service clients up to 50 employees. For more information, checkout the ADP Small business HR and payroll software solution page.
- ADP Workforce Now is for Mid-Market clients. Typically, clients have fewer than 1000 employees, but there are clients who are quite larger who are on this platform. For more information, check out the ADP Workforce Now page.
The development effort related to data exchanges powered by ADP Platform APIs are also referred as ADP API Integration. The effort largely varies depending on your integration use case as well as the ADP platform. Typically, more effort is required to develop integration for bi-directional data exchange than uni-directional. In addition, you should plan to spend more time if more data elements are being exchanged.
ADP API documentation is listed under the Guides section, found here developers.adp.com.
We recommend you review other integrated solutions available in the ADP Marketplace.
Exercise 5.1.1: Establishing your API Use Case.
- 1 to 3 days, depending on your integration requirement
- Review the Integrations by Solutions Guide
- Identify the list of APIs for your application based on your use case
Exercise 5.1.2: Understanding the Data Connector and End-User Application Authorization process.
- 2 to 4 hours
There are two types of data integration applications depending on the nature of the application:
- Data Connector Applications connect to ADP's platform and consume data without an end-user's involvement. Typically, these are the scheduled programs or programs triggered by a set condition to exchange data between an ADP platform and your core application. An example would be synchronizing employee records using ADP platform as the system of record (SOR).
- End-User Applications requires an individual to log in using their ADP credentials. These applications must obtain authorization to gain access to the end-user's data. The data will be transmitted/exchanged between an ADP platform and your core application using the end-user's credentials.
- Read Understanding the Data Connector App Authorization Process
- Review More about ADP Data Connector (optional reading)
- Review the Understanding the End-User App Authorization Process
Exercise 5.1.3: Learning About ADP API Security
- 4 to 6 hours (approximate to understand all the below documentation)
You have already retrieved:
- Mutual SSL Certificate from Chapter 2.1.2
- Test Instance Credentials from Chapter 2.1.3
- Partner Credentials from Chapter 2.1.4
Review the following documents below:
- An Introduction to Mutual SSL
- Access Tokens
- Implement the Credentials API (using your partner credentials) to fetch a client’s OAuth 2.0 Client Credentials
- How to Retrieve Client Credentials of a Subscriber
- Make Your First API Call Using Postman
- Implement ADP Marketplace Integration best practices (Client Credentials and Token Management)
- Build Framework for Event Queue API
- Implement exception handling based on ADP recommendations
- Watch the Worker API and Credentials.read webinar
- Try to make API calls to retrieve client credentials.
- Understand the ADP API security design.
- Understand what's required to make API calls to ADP.
- Understand client-level API security by leveraging the credential.read API.
- Understand ADP Marketplace Integration best practices.
- Understand the Event Notification Queue and how to keep data in sync.
- Understand exception handling based on ADP recommendations.
Exercise 5.2.1: Learning About Consent Management
- 2 to 4 hours
If a client does not provide consent for your application to access their data managed by ADP, the credentials.read API request would result in error. In addition, all API requests would fail.
Exercise 5.3.1: Define Development Milestone dates and send to ADP contacts
- 1 day
- Once you are done developing and testing your ADP integration, we would like to hear from you!
- Fill out your target Milestone dates and email them to your contact from ADP
- Gain approval from ADP team for the Milestone dates
- Once approved, you are free to start development activities within Developer Self-Service portal