## How to connect to the ADP Workforce Now API 

Apideck enables you to build a native integration with ADP Workforce Now. This explains guide explains how to configure the "ADP Workforce Now" connector. 

### Prerequisites

Before you begin, make sure you have the following:

1. A [partnership with ADP](https://partners.adp.com) or purchase the [ADP API Central app](https://apps.adp.com/en-US/apps/410612).
2. An Apideck account

### Enable the ADP Workforce Now connector in Apideck

In Apideck, go to Configuration > HRIS API and enable ADP Workforce Now in the list of connectors.

![](https://res.cloudinary.com/apideck/image/upload/v1690214616/docs/connectors/adp-workforce-now/step-2-enable-adp-workforce-now.png)

### Getting credentials through a partnership with ADP

#### Generate a signed ADP Certificate (SSL Certificate File and SSL Key File)

1. Go to your [ADP Partner self-service portal](https://adpapps.adp.com/self-service). 
2. Click "Certificate" in the left navigation.

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/get-certificate.png)

3. Click the "Request Certificate" button. 

![](https://res.cloudinary.com/apideck/image/upload/v1690214924/docs/connectors/adp-workforce-now/step-3-adp-certificate.png)

4. Fill in your app details and click "Next".

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/request-certificate.png)

5. Copy your Private Key using the "COPY" button and save it in a local file, since you need it later.

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/request-certificate-key.png)

**💡 TIP**: copy the full key, with ---BEGIN PRIVATE KEY--- and ---END PRIVATE KEY--- included

6. Continue through the certificate generation process.

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/request-certificate-finalize.png)

7. On the "Certificate" screen, click "Download", which triggers a download of a ".pem" file. Save the ".pem" file.

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/download-certificate.png)

8. Open a text-editor, to view the content the downloaded ".pem" file

<img src="https://res.cloudinary.com/apideck/image/upload/v1691592675/docs/connectors/adp-workforce-now/pem-file-text.png" title="" alt="" width="445" />

**💡 TIP**: copy the full content of the PEM certificate, starting with -----BEGIN RSA PRIVATE KEY----- including -----END CERTIFICATE----- 

#### Get you OAuth Client ID & Secret

1. Login to the [ADP Partner self-service portal](https://adpapps.adp.com/self-service), navigate to the "Projects" section from the left-hand navigation pane

2. Select a Project in ADP

3. Click on th "Development API Credentials" tab

4. In the first section of the page you will see the Client ID & Client Secret.

**💡 TIP**: Copy the "Client Id" and the "Client secret". You will need them in the next step.
### Getting credentials with the ADP API Central app

1. Purchase and access the ADP API Central portal

2. Login to your ADP account

3. Create a new project:
   - Click "Projects" in the left menu
   - Click "Create Project" button
   - Enter a project name and description
   - Select "Employee Demographic Data (Read/Write)" use case
   - Click "Create Project"

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/api-central--select-usecase.png)

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/api-central--create-project.png)

4. Generate certificate:
   - Click "Manage Certificate" 
   - Follow steps to generate certificate
   - Download and save both certificate and private key files

![](https://res.cloudinary.com/apideck/image/upload/v1691587073/docs/connectors/adp-workforce-now/api-central--generate-certificate.png)

**💡 TIP**: Include the full key text with ---BEGIN PRIVATE KEY--- and ---END PRIVATE KEY--- headers

5. Copy the project's "Client ID" and "Client Secret" - you'll need these for the next step

### Vault Connection Setup

Now that you have your ADP Workforce credentials, you can enter the integration credentials to connect to ADP instances in a secure manner.

Goto the Apideck > Configuration > HRIS > [ADP Workforce Now](https://platform.apideck.com/configuration/hris/adp-workforce-now)

![Apideck - Configure OAuth credentials](https://res.cloudinary.com/apideck/image/upload/v1691591792/docs/connectors/adp-workforce-now/apideck-adp-configuration.png)

Enter the [OAuth client ID & Secret](#get-you-oauth-client-id--secret) from ADP.

Next we have to enter the content of the Client certificate & key, so Copy & paste the content of the [SSL Client Certificate & Key](#generate-a-signed-adp-certificate-ssl-certificate-file-and-ssl-key-file).

Press "Save settings" to save your credentials.

Now you are ready and clients can authorize the connection to their ADP Workforce account securely.
 
## Do your first API call to the HRIS API

- Connect your ADP Workforce account through [Vault](https://platform.apideck.com/vault) with a test session.

- To test the access token, make a query to get your [`Employees`](https://developers.apideck.com/apis/hris/reference#operation/employeesAll) endpoint using the [HRIS API](https://developers.apideck.com/apis/hris/reference#operation/employeesAll).

```
curl --location --request GET 'https://unify.apideck.com/hris/employees' \
--header 'x-apideck-consumer-id: test-consumer' \
--header 'x-apideck-app-id: {APIDECK_APP_ID}' \
--header 'x-apideck-service-id: adp-workforce-now' \
--header 'Authorization: Bearer {APIDECK_API_KEY}'
--header 'Content-Type: application/json' \
```

## Start building with the ADP Workforce API

Learn what else you can [build with the ADP Workforce API](https://developers.apideck.com/apis/hris/adp-workforce-now).

Interested in a personalized demo? [Let us know](https://www.apideck.com/demo-request?from=guide).
