Intellectia Postman Setup Guide

Intellectia Postman Setup Guide

To contribute to the Intellectia backend, you need to use our Postman public repository. This guide will walk you through the setup process.

Access the Postman Repository

1. Click on the following link to access the Intellectia Postman repository: Intellectia Postman Repository.

2. Note that you won't be able to edit anything in this repository until you fork it. This is similar to how you fork a repository on GitHub.

Forking the Repository

1. To fork the repository, you need to sign in to Postman. If you're already a member, simply sign in. If not, create a new account by clicking the "Signup for free" button.

2. Follow the signup steps, and you'll be redirected back to the Intellectia workspace (repository).

3. To fork the repository, click the fork icon located in the upper right section (highlighted in the picture below).

   

4. After clicking the fork icon, a new tab will open. Simply click the "Fork Collection" button to create your fork successfully (as shown in the image below).

   

Configuring Environment Variables

1. Now it's time to configure the environment variables. Click the "Environments" menu item located in the left section, as shown in the picture below:

   

2. Create a new environment by clicking the plus button located at the top left section (as shown in the picture below):

   

3. Once you click the plus button, an input field will be highlighted automatically. Name your environment "LOCAL" since you'll be testing the API locally on your machine. A new tab called "LOCAL" will appear on the left side.

4. Hover over the "LOCAL" tab, and a checkmark icon will appear. Click the checkmark to mark "LOCAL" as the active environment (as shown in the image below).

   

5. Great, "LOCAL" is now your active environment.

6. After clicking the checkmark, look to the right side. A form-like section is there for adding new environment variables to your "LOCAL" environment.

Adding Environment Variables

Adding the "token" Variable:

1. To create the "token" variable, click the input field to add the variable name (as shown in the picture below). Enter "token" into the field.

   

2. Choose "secret" as the variable type. Leave other fields blank for now. We'll come back to this.

Adding the "host" Variable:

1. To create the "host" variable, follow the same process. Choose the variable type as "default" and enter "http://localhost:3001" for the initial and current values. These values should be the same.

2. Don't forget to save the environment by clicking CTRL + S.

Obtaining Your Token

1. Ensure the application is running. If you're unsure about setting up the application, refer to the README section on our repository.

2. Once the application is up and running, click the "Collections" menu item located in the left section.

3. Open the folder "Authentication" and click the POST route called "Signup with email and password" (as shown below).

   

4. After that, click the blue button that says "SEND." Wait for the response to come back.

5. Once you receive a response, copy the value of the "token" field (as shown in the picture below).

   

6. Navigate back to the Environments section, and in the "token" field, add the copied token as both the initial and current values ( as shown in image below ).

   

7. Save the environment (CTRL + S).

That's it; you're done. If your token expires or you delete the database, follow a similar process to add your token again to the ENV section. Enjoy using Intellectia!