Overview
This guide provides an overview of using Postman to make your first application programming interface (API) call to ADP.
Intended audience
This document is intended for:
- Architects
- Developers
Prerequisites
You need to have the following ready before making your first API call:
- Client ID and Client Secret: If you don't have this information, contact your client representative
- Certificate
- Private key
These are all a result of the process as described in the ADP Marketplace ESI - Getting started document.
Installing and preparing postman
-
Install Postman from https://www.getpostman.com/apps
-
Using the following steps, add your ADP issued .PEM file and your .KEY file (generated as part of the CSR process) into Postman for the domains. You can use the instructions found at https://www.getpostman.com/docs/postman/sending_api_requests/certificates)
-
Click 'Settings'
-
Click Certificates, Add Certificates and select the CRT file (certificate) and KEY file, then click Add.
This step has to repeated for the following Hosts:
- https://accounts.eu.adp.com
-
https://api.eu.adp.com
- On the Settings page, turn the SSL certificate verification on.
-
Import the Postman collections
Postman allows you to store a collection of APIs and share them with others. For example, you can find the collection examples used in this document by clicking here. When at the location, download the file and click Import to import the list file.