Postman collection

Important: Before you begin, contact our Sales Team to set up your Payroc account and to get your API key.

To use our Postman collection, you need to:

  1. Create a Postman API key.
  2. Clone our repository.
  3. Authorize your requests.

Create a Postman API key

  1. Go to https://postman.co/settings/me/api-keys. Postman might prompt you to sign in.
  2. Select Generate API Key.
  3. In the Name your key field, enter Payroc-API, and then select Generate API Key.
  4. Copy and save your Postman API key.

Copy our repository

  1. Go to https://github.com/payroc/api-postman-collections.
  2. Go to Releases and download the zip file. Extract the contents of the file.
  3. Open a PowerShell terminal, and then run the Setup.ps1 script in the temrinal.
  4. In the PowerShell terminal, the script prompts you to enter your Postman API key and then enter your Payroc API Key.

Note: If you get the error Setup.ps1 cannot be loaded because running scripts is disabled on this system, it means that you don’t have permission to run this script. To bypass this issue, use: powershell -ExecutionPolicy Bypass -File .\Setup.ps1

Authorize your requests

To automatically populate each request with a bearer token, complete the following steps:

  1. Launch the Postman application.
  2. From the Workspaces dropdown menu, select Payroc-API.
  3. Select Collections, and then select Payroc Identity Service, and then select the Authorize request. Authorize request
  4. From the Environment dropdown menu, select Payroc-UAT. Payroc UAT
  5. To send the Authorize request, select Send.

Note: If your token expires, send the Authorize request again.