Using JH Public Postman for OAuth

The Developer Relations team has created a public Postman collection to allow consumers to quick configure and test our APIs without having to develop code. This tutorial will work in conjunction to our Public Postman Collection tutorial and will focus on the steps to configure a user’s credentials to perform OAuth 2.0 credentials testing.

Access the Collection

Please refer to our JH Postman Public Collection tutorial for steps on accessing the Developer Relations created Postman collection and forking(copying) it to your workspace.

Configure JX OAuth Scenario

Before we can use the scenario, we must first configure the variables that will use your particular credentials.

1. Within the left-hand menu, click on the Scenario: JX Outh option then select the Variables tab on the right-hand window.

   

2. In the Variables tab:

• Click on the row for auth_client_id and enter the Client Id provided to you by Jack Henry.
• Click on the auth_private_key row and enter the private key portion of your key pair.
• This last step involves grabbing information from an assertion page. This page will display a large amount of text data. You must select all the data from the page and copy it into the jsrasign-js field. Obtain the assertion information from the JH provided option by clicking here. This link is also included within the Initial Value field for the jsrasign-js row. (If your development team has there own assertion, you may use it instead.)

3. Click the Save button in the upper right-hand corner.

Configure the Postman Environment

Postman environments assist with the setting up environmental variables once and using them in many times within the API structure. If you elected to copy the Auth labeled environment(s) when you forked the Scenario: JX OAuth over to your workspace, the following steps will assist in setting up that environment.

1. On the far left-hand menu, select Environments to see a list of available environments within your workspace.
2. In the Environment chosen there are two columns that accept values, we will be entering our values only within the Current Value column. Some values will be left blank.

3. Click on the Save button in the upper right-hand corner.
4. Once the environment is configured, ensure that you have it selected by within the upper right-hand corner box of the main window.

Performing API Tests

Obtain a Token

Before using any of the provided test APIs, a consumer must obtain a token. This Postman scenario is setup to automatically save the token into the Scenario: JX OAuth Variables tab.

1. Within the left-hand menu, click the Do First - Token Request then select Request Token.
2. Click the Send button.
3. If everything is configured correctly, you will see the bottom right-hand window populate with a status of “200 Ok” and ‘access token’ with data following. Similar to the screen shot.

Testing An API

1. On the left most menu, select Collections.
2. Select the Scenario: JX OAuth collection.
3. In the middle menu, select an API family and API that corresponds to an API you have requested access. e.g. AcctInq (TPG_Inquiry - AcctInq 011001276)
4. Once the API option is selected, click the Send button. (Note, if the Environments option was not selected in this process, you will need to edit the body of the API to fill in the appropriate values within the jXchangeHdr. This tutorial will not cover those steps.)
5. If all works as expected, the API response will populate within the bottom window.

Troubleshooting FAQ

I am getting the error “invalid client” when I attempt to request a token.

This usually means that an invalid private key or client id has been entered. Please check your setup within the Scenario: JX OAuth Variables tab discussed within the Configure Scenario: JX OAuth.

Receiving error: “ID3242: The security token could not be authenticated or authorized.” when performing an API request.

This indicates that you have not requested a token or that your token is not valid.

• Please check your setup within the Scenario: JX OAuth Variables tab discussed within the Configure Scenario: JX OAuth.
• Please ensure that you have requested a token by following the Obtain A Token steps above.

I am seeing an “Access is denied” error when performing an API request.

This usually indicates that the jXchangeHdr values within the API body are incorrect.

• If you used the Configure the Postman Environment option, please check that you have the environment selected and that the appropriate values are used.
• If you did not option to use the Postman Environment, please review the body of the API request to ensure that the proper values are entered into the jXchangeHdr.
• Was this API part of the list of APIs requested for development? If the API is not optioned and configured within the JH system, then this error will occur.