External links: ADP API explorer
Important: Before integrating with ADP, you must purchase API access for your account. You may be asked to pay a one-time implementation fee and recurring monthly fees for API access. Contact ADP support for details.
You can connect to either of the following ADP accounts:
- Production account – an account in your production environment
- User acceptance testing (UAT) account – an account in your sandbox environment
Check the info you received from ADP when you signed up to see which accounts you have access to.
Install and configure OpenSSL
SSL connections to ADP require you to install OpenSSL Light and modify the system variables for your OS.
See OpenSSL for more information about installing OpenSSL Light.
Get a client ID
To get a client ID, create a .csr file and a .key file. System access and command usage varies by operating system.
Create a .csr file and a .key file on a Mac
Since Mac operating systems currently only support an older version of OpenSSL (LibreSSL), Celigo recommends installing Homebrew.
Mac uses bash shell, so you can add environment variables to your .bash_profile file. Verify that these files visible on your machine.
Note: At the end of the file, you may have export command lines. If so, add these environment variables here. If not, just add them at the end of the file.
- Enter the following command:
- Restart the terminal, then enter the following command:
- Check that your OpenSSL version has been updated with the following command:
- To generate the .key file, enter this one-line command:
openssl genrsa -out yourcompanynamehere_auth.key 2048Replace yourcompanynamehere with your company’s name.
- To generate the .csr file, enter the following one-line command:
openssl req -new -key yourcompanynamehere_auth.key -out yourcompanynamehere_auth.csrReplace yourcompanynamehere with your company’s name.
- Email the .csr file to your ADP representative.[a][b]
Create a .csr file and a .key file on a Windows machine
Use the following steps to add the OPENSSL_CONF variable to your system variables.
- Click the Windows Start button and search for “Edit the system environmental variables.”
- Click Edit the System environment variables.
- The System Properties window opens to the Advanced tab. Click the Environment Variables... button in the lower right corner of the window.
- In the System variables section, click New....
- Type OPENSSL_CONF in the Variable name field.
- Type c:\OpenSSL-Win32\bin\openssl.cfg in the Variable value field.
- Click OK.
- In your OS, open the openssl.cfg file.
- In the [req_attributes] section, delete unstructuredName = An optional company name.
- Note: For Windows users: Open a command prompt and go to c:\OpenSSL-Win32\bin. Then move to the next step.
- To generate the .key file, use this one-line command:
openssl genrsa -out yourcompanynamehere_auth.key 2048
Replace yourcompanynamehere with your company’s name.
- To generate the .csr file, use this one-line command:
openssl req -new -key yourcompanynamehere_auth.key -out yourcompanynamehere_auth.csr
Replace yourcomanynamehere with your company’s name.
- Email the .csr file to your ADP representative.
After your ADP representative gets your .csr file, they will send you your client ID and client secret. We use your client ID as proof that an authorized person wants to establish a connection between ADP and our platform.
- Client secret: Enter your client secret. To get a client secret, you need to create a .csr file and a .key file: Note: The way you access your system and these commands will vary based on the operating system you use.
- SSL certificate: Upload your SSL Certificate into this field. To get an SSL certificate: Note: The way you access your system and these commands will vary based on the operating system you use.
- SSL client key: Upload your SSL client key into this field. To get an SSL client key, you need to generate one in an OpenSSL environment: Note: The way you access your system and these commands will vary based on the operating system you use.
- SSL passphrase: You can set a password or phrase for your SSL certificate and key for additional security.