About ADP Human Capital Management (HCM) Platforms
ADP HCM Platforms provide APIs your application can leverage for bi-directional 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 one-directional. In addition, you should plan to spend more time if more data elements are being exchanged.
ADP documentation is listed under the Guides section of developers.adp.com. You can start with the following:
We recommend you to checkout other integrated solutions available in the ADP Marketplace. The Integration Details are normally described under the Features page for an app.
Exercise 3.1: Reviewing the API Catalog
1 to 3 days, depending on your integration requirement.
- Log into the ADP Developer Portal and review API guides by starting with the following guides:
- Identify the list of APIs for your application.
- Identify the list of APIs your application needs to consume.
- Assess the complexity and level of effort in to create your desired integration use case.
About Marketplace Integration Application Types
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 synchronize 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.
The authorization model is different and you should determine which type of application to build.
Exercise 3.2: Understanding the Data Connector Authorization Process
2 to 4 hours
- Read Understanding the Data Connector App Authorization Process.
- Review More about ADP Data Connector (optional).
Understand what a Data Connector application is and how to authenticate and gain authorization.
Exercise 3.3: Understanding the End-User Application Authorization Process
2 to 4 hours
Learn more about an end-user application, how to authenticate and gain authorization, and how to retrieve end-user identity and log out an end-user.
Exercise 3.4: Learning About the ADP Marketplace Integration Best Practices
4 to 8 hours
Review the ADP Marketplace Integration Best Practices.
Understand the best practices for integration.
Exercise 3.5: Learning About ADP API Security
2 to 4 hours after receiving a Certificate Signing Request.
Required Setup for Step 3 of this Exercise
- Partners who have access to the ADP developer self service tool should request and upload a Certificate Signing Request (CSR) using the tool.
- Partners who do not have access to the ADP developer self service tool would need to request a Certificate Signing Request (CSR) by following the process in Generating a Certificate Signing Request, which normally takes 1 to 2 business days.
- Review the following documents:
- An Introduction to Mutual SSL
- Access Tokens
- How to Retrieve Client Credentials of a Subscriber
- Consumer Application Subscription Credentials - check out the Examples tab
- Make Your First API Call Using Postman
- Troubleshoot App Integrations with ADP
- Using Consent Manager to Control Access to Your Data
- Watch the Worker API and Credentials.read webinar.
- Try to make APIs to retrieve client credentials (optional). In order to make calls you will need to get API credentials, you must create a project in the self service portal to get API 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 a commonly used API; the worker API.
Exercise 3.6: Designing Your Integration
1 to 3 days
Download and complete the ADP Partner Data Integration Specification Document.
- Identify Data Integration requirement.
- Assess effort level, assign/commit resource, and set the milestone ADP API Integration target completion date in Exhibit 3, under the Marketplace Developer Participation Agreement.
Exercise 3.7: Learning About Consent Management
2 to 4 hours
If a client didn't provide the 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. Therefore, you would need to assess the level of effort to handle API exceptions, assign/commit resource, and set the milestone Consent Management target completion date in Exhibit 3, under the Marketplace Developer Participation Agreement.