In order to connect to your ADP instance, you must provide us with four key elements to do a successful connection:
- Client ID: This is your ADP application account identifier.
- Client Secret: Your ADP application account Secret.
- Certificate (PEM): X.509 object represented in PEM format.
- RSA Private Key.
We are going to show you the process to obtain these authentication credentials.
Obtaining Authentication Credentials
In order to obtain the above Client ID, Client Secret, PEM Certificate and Key, you will need to take the following steps:
- Open an ADP Developer Account.
- Create an ADP app to obtain a Client ID and Client Secret - this can be
done in the ADP admin interface, or you could contact your ADP
representative to request this.
- Use OpenSSL to generate a key and Certificate Signing Request (CSR)
If you are using Windows, instructions for setting up OpenSSL can be found in the ADP developer documentation in the following link:
You can generate a .key file (enter the information you are prompted for and leave the challenge password blank):
openssl genrsa -out yourcompanynamehere_auth.key 2048
The .key file can then be used to generate your Certificate Signing Request (CSR) :
Openssl req -new -key yourcompanynamehere_auth.key -out
4. Obtain your PEM certificate: You can use the CSR generated in step 3 to request a PEM certificate from ADP. This can be done by either emailing it to your ADP representative or by requesting the url for the ADP certificate signing tool (including instructions on how to fill in the webform). The result of this process is that you will receive your PEM certificate.
Setting up ADP APIs and permission scopes
You will need to communicate with your ADP rep to make sure that the app created has the correct permissions and scopes enabled so that our connector will be able to access the correct ADP endpoints and thus have the operations we require and returns the desired data.
For example you may ask for our connector to make use of the ADP workers v2 API . This:
- Utilizes the endpoints found at https://api.adp.com/hr/v2/workers
- Requires the scope:
- Exposes values found in the People > Personal Information and
People > Employment areas of ADP Workforce Now.
You will need to analyse the endpoints available in the different ADP APIs to make sure that your needs are met in terms of data that will be available through our connector. This will require some communication with your ADP rep.