You need to have the following ready before making your first API call:
Postman allows you to store a collection of APIs and share them with others. ADP will continue to share sample collections on GITHUB.
For example, you can find the ADP Workforce Now collection by clicking here. When at the location, download the file and click Import to import the list file.
Each request to one of ADP's APIs needs to be accompanied by an Authorization header containing a bearer token issued by the ADP Security Token Service.
In Postman, open the Token Request. To expose the headers, click Headers.
If your POST request is successful, you will receive an HTTP 200 from the server with your token in the body of the response. Copy the access_token value.
You will receive an Access Token in response, which is valid for one hour. The same can be used to make API calls by adding the following header:
Authorization: Bearer{accessToken}
Postman allows you to store a collection of APIs and share them with others. ADP will continue to share sample collections on GITHUB.
For example, you can find the ADP Workforce Now collection by clicking here. When at the location, download the file and click Import to import the list file.
If you already have an API collection, you can select an API from a collection. The following sample shows selecting the GET HR - Worker (List) API and making the first call.
Open the HR > Worker (List) request and click Headers to expose the headers.
Paste your bearer token into the Authorization header and click Send.
Remember to leave the Bearer and a space to the left of your token. Since Postman is a browser-based application, the browser caching mechanism will save responses to the cache. To ensure that changes you make in ADP applications are reflected in Postman, we recommend placing a cache-buster into the query string between each request.
For example, preventCache=timestamp, where timestamp is a unique value such as the current time. You won't need to do this when you're building your application because browser-based caching won't come into play.
If your request was successful, you'll receive an HTTP 200 message from the server within a few records. The following sample shows a response of the GET HR - Worker (List) API request:
An HTTP 401 error is returned from the ADP Security Token Service when you fail to provide valid credentials in the request header.
Take the following suggested troubleshooting steps before contacting your ADP Representative for assistance:
An HTTP 401 error is returned from APIs other than the ADP Security Token Service when you fail to provide a valid bearer token in the request header.
Take the following suggested troubleshooting steps before contacting your ADP Representative for assistance:
An HTTP 403 error is returned from the server when the bearer token you provided is valid, but you are not authorized to access the resource you have requested.
First, confirm that you have not made a mistake in the request Uniform Resource Indicator (URI). If the request URI is correct, contact your ADP Representative to request access to the URI in question.
Copy the entire JavaScript Object Notation (JSON), which is highlighted as follows:
Select Postman > Import Tab > Paste Raw Text.
Click Import
Create a connection based on your grant type using the connection factory
# Using the new configuration object create a connection
acConnection = ADPAPIConnectionFactory().createConnection(AuthorizationCodeConfiguration)Create a connection based on your grant type using the connection factory
//get ADP connection using Connection factory and configuration
authorizationCodeConnection = (AuthorizationCodeConnection)
CONNECTION_FACTORY_INSTANCE.createConnection(authorizationCodeConfiguration);
//get Url from authorization connection
authorizationUrl = "redirect:" + authorizationCodeConnection.getAuthorizationUrl();
//CALL BACK HANDLER
//get code value
String requestCode = (String) request.getParameter("code”);
//map request code to connection configuration
((AuthorizationCodeConfiguration) authorizationCodeConnection.getConnectionConfiguration()).setAuthorizationCode(requestCode);
