How To Connect ADP API using HTTP Connection over OAuth Connection

Introduction

In this post, we will cover how to connect ADP API using HTTP connection manager over OAuth connection manager with JSON Source. ADP API works a bit differently with the OAuth connection manager. Let’s take a look at it…

Prerequisites

Before we perform the steps listed in this article, you will need to make sure the following prerequisites are met:

    1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
    2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
    3. Make sure ZappySys SSIS PowerPack is installed (download it).
    4. Optional (If you want to Deploy and Schedule ) – Deploy and Schedule SSIS Packages
    5. Make sure you have ADP Client Id & Secret.

What things are needed to connect ADP API

    1. You need to have the Client ID and Client Secret before making your ADP API call.
    2. If you don’t have this information, contact your client representative.
    3. Certificate Signing Request (CSR): For more detailed information, see the Certificate Signing Request: https://developers.adp.com/articles/general/generate-a-certificate-signing-request
    4. If you already have the .csr file from your API Settings as below: –
       ADP CSR Certificate

      ADP CSR Certificate

       

    5. Then you need to convert those *.cer + *.key files to *.PFX
    6. We do not support cert+key files but converting to PFX is fairly simple.
    7. You can find many blog posts on how to convert to PFX. Here are some helpful links on how to convert *.pem to *.PFX (i.e. PKCS#12 OR p12 file format)
      -https://www.sslshopper.com/ssl-converter.html
      -https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate
    8. Once you have .PFX certificate, Client ID, and Client Secret ready then you can provide these details to the  HTTP Connection manager as below: –
      General Settings: –

       ADP HTTP Connection Manager - General Tab

      ADP HTTP Connection Manager – General Tab

      Client Certificate: –

       ADP CSR Client Certificate Tab

      ADP CSR Client Certificate Tab

    9. After you provide all the required details in HTTP Connection Manager for ADP API.
    10. You can select HTTP Connection manager as the connection provider in the JSON Source/REST API and preview the data.
    11. Here you can connect ADP API successfully using the HTTP connection manager.

 

Conclusion:

This is how you can successfully connect ADP API using HTTP Connection over OAuth connection using ZappySys JSON Source/REST API.

Posted in REST API, Uncategorized.