Postman is an online tool that makes testing APIs easy. All you need is a free account.

🎓

Prerequisites

1. Create an account
2. Activate your account
3. API Authentification

Create Postman account and fork HrFlow workspace

1. Go to Postman website and create your account. You can use your Google account to login. Then, you can fork the Postman collection by clicking on the button:
   

🪄

If you have successfully forked the collection from the button above, you can directly go to Set up your workspace

2. Navigate to the official HrFlow Postman workspace or enter "hrflow" in the search bar and click "HrFlow.ai Public Workspace"

We need to fork the official workspace to modify environment variables and customize requests parameters.
We actually need to fork two elements: the collection containing all the requests and the empty environment where we'll enter variables like API key, user email etc...

3. Click on "Collections" on the left panel. Right click on HrFlow.ai API, then "Create a fork".

Change the name of the fork and in "Environments to fork", select "Empty - Environment".

Now click "Fork Collection".

Set up your workspace

1. Now go back to your workspace (Workspaces > My Workspace).

2. Click on "Environments" on the left panel and select "Empty - Environment". You can rename it by right-clicking on it and selecting "Rename".

2. Update x-api-key and x-user-email by changing the Current Value column. Some API endpoints will require you to change other variables. Save your environment (Ctrl + S or "Save" button) and go back to Collection > HrFlow.ai API (left panel).

3. Change the active environment by clicking on "No environment" on the top-right-hand corner and selecting your environment.

   

4. Unfold the "HrFlow.ai API" and click on "Try your API keys". Send the request: you should see response with "code": 200 indicating success.

Test all our endpoints

Here is a checklist for when you try out a new endpoint:

1. Make sure that you have set your environment

2. Make sure all required parameters are set in Params and in Body. Most of API Endpoints also require you to set some environment variables. Just like before, navigate to you environment, set the missing variable in Current Valuecolumn and save it.

🚧

Missing variables

In Postman, red text means that a variable is missing while blue text means a variable is set: missing variables can be set in Params , Body, or in the environment