{"id":9687,"date":"2022-06-23T17:35:02","date_gmt":"2022-06-23T17:35:02","guid":{"rendered":"https:\/\/zappysys.com\/blog\/?p=9687"},"modified":"2025-04-01T12:54:41","modified_gmt":"2025-04-01T12:54:41","slug":"connect-adp-api-using-http-connection-oauth-connection","status":"publish","type":"post","link":"https:\/\/zappysys.com\/blog\/connect-adp-api-using-http-connection-oauth-connection\/","title":{"rendered":"How To Connect ADP API using HTTP Connection over OAuth Connection"},"content":{"rendered":"

Introduction<\/h2>\n

In this\u00a0post, we will cover how to connect ADP API using HTTP connection manager over OAuth connection manager with JSON Source<\/a>. ADP API works a bit differently\u00a0with the OAuth connection manager. Let’s take a look at it…<\/p>\n

Prerequisites<\/span><\/h2>\n

Before we perform the steps listed in this article, you will need to make sure the following prerequisites are met:<\/p>\n

    \n
  1. SSIS<\/abbr>\u00a0designer installed.\u00a0Sometimes it is referred as\u00a0BIDS<\/abbr>\u00a0or\u00a0SSDT<\/abbr>\u00a0(download it from Microsoft site<\/a>).<\/li>\n
  2. Basic knowledge of SSIS package\u00a0development using\u00a0Microsoft SQL Server Integration Services<\/em>.<\/li>\n
  3. Make sure\u00a0ZappySys SSIS PowerPack<\/a>\u00a0is installed (download it<\/a>).<\/li>\n
  4. Optional<\/strong>\u00a0(If you want to Deploy and Schedule ) –\u00a0Deploy and Schedule SSIS Packages<\/a><\/li>\n
  5. Make sure you have ADP Client Id & Secret.<\/li>\n<\/ol>\n

    What things are needed to connect ADP API<\/span><\/h2>\n
      \n
    1. You need to have the Client ID and Client Secret before making your ADP API call.<\/li>\n
    2. If you don’t have this information, contact your client representative.<\/li>\n
    3. Certificate Signing Request (CSR): For more detailed information, see the Certificate Signing Request:\u00a0https:\/\/developers.adp.com\/articles\/general\/generate-a-certificate-signing-request<\/a><\/li>\n
    4. If you already have the .csr file from your API Settings as below: –\n
    5. Then you need to convert those *.cer + *.key files to *.PFX<\/li>\n
    6. We do not support cert+key files but converting to PFX is fairly simple.<\/li>\n
    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)
      \n-https:\/\/www.sslshopper.com\/ssl-converter.html
      \n-https:\/\/stackoverflow.com\/questions\/808669\/convert-a-cert-pem-certificate-to-a-pfx-certificate<\/li>\n
    8. Once you have .PFX certificate, Client ID, and Client Secret ready then you can provide these details to the\u00a0 HTTP Connection manager as below: –
      \nGeneral Settings: –<\/p>\n
      \"<\/a>

      ADP HTTP Connection Manager – General Tab<\/p><\/div>\n

      Client Certificate: –<\/p>\n

      \"<\/a>

      ADP CSR Client Certificate Tab<\/p><\/div>\n

        \n
      1. <\/li>\n<\/ol>\n<\/li>\n
      2. After you provide all the required details in HTTP Connection Manager for ADP API.<\/li>\n
      3. You can select HTTP Connection manager as the connection provider in the JSON Source\/REST API and preview the data.<\/li>\n
      4. Here you can connect ADP API successfully using the HTTP connection manager.<\/li>\n<\/ol>\n

        Note:<\/strong> By default, when a PFX file<\/strong> expires, the ADFP API<\/strong> throws a generic SSL\/TLS channel error<\/strong>, which can be misleading. To verify the certificate\u2019s expiration date, we have to:<\/p>\n

          \n
        1. Import the PFX file<\/strong> into the local certificate store (using the same blank password).<\/li>\n
        2. Use the mmc<\/code> command from the Start menu.<\/li>\n
        3. Go to Add\/Remove Snap-ins \u2192 Certificate \u2192 User Store \u2192 View Entry<\/strong> to check the expiration date.<\/li>\n<\/ol>\n

          Steps to Convert .cer and .key Files into a .PFX File<\/h3>\n

          If you have separate .cer<\/strong> and .key<\/strong> files, you\u2019ll need to convert them into a single .PFX<\/strong> file (PKCS#12 format) to use with our tool, as it does not support separate certificate and key files.
          \nConverting to PFX<\/strong> is straightforward, and you can find many detailed guides online. Here are some helpful links:<\/p>\n