How to download and use the Postman Collection for your Project
Overview
With Neurelo, you can easily download a Postman collection for your automatically generated endpoints. This guide will help you start using this resource from the API documentation page.
Download the Postman Collection for your Project
To get the Postman collection, you can either
Download the collection from under the "Docs" section with the Definitions for your project, or
Download the collection from the "APIs" section in your environment.
In this guide, we will go over the details of how to download the spec from the environment view, but the process is similar for downloading the spec from the "Docs" section in the definitions view.
Navigate to your environment's tab:
This action will display the API section tailored to the commit selected for your environment.
Look for a download (↓) icon at the top-right corner of this tab. Clicking this icon reveals the specifications and SDK download dropdown.
Selecting the Postman collection option will initiate the download of a JSON-based Postman collection file.
Note: The downloaded spec varies depending on whether you are in the REST or GraphQL section. To download a Postman collection for GraphQL, ensure you switch to the GraphQL tab in the API documentation before downloading.
Importing the Collection into Postman
To import the downloaded collection into your Postman app, start by clicking the 'Import' button within Postman.
Then, import the JSON-based Postman collection file you downloaded from Neurelo.
Completing these steps will generate a new Postman collection corresponding to your schema.
Using Neurelo’s Postman Collections
Neurelo structures each collection by creating individual folders for each object in your schema, organizing these folders according to the auto-generated API endpoints. Each object is equipped with auto-generated GET (to find, aggregate, and group objects), POST (to create one or multiple objects), PATCH, and DELETE HTTP methods.
Note - this section discusses the Postman collection for Neurelo REST endpoints. For GraphQL, the only support HTTP method will be POST
Required Setup
Once the Postman collection has been imported into Postman, you need to configure the {{baseUrl}} and set the X-API-KEY to be used in the header for the API calls.
You can get the {{baseUrl}} for your environment by navigating to the Environments section in your project
Use the API Key associated with your environment for the value of the X-API-KEY header
You can set these globally (and then they will be used for all the API calls), or set them per API.
Global Settings
Click on the Collection Name in your Workspace and it will show you tabs including "Authorization" and "Variables"
Click on the "Authorization" tab and enter the X-API-KEY for your environment in the "Value" field. Once you input the API Key, the value should look something like this
Click on the "Variables" tab and enter the URL for your environment under "Current Value" Once you enter the URL, it should look something like this
Important - Remember to click "Save" at the top right to make sure your changes will be used
Per API Setting
If you have configured the {{baseUrl}} and the X-API-KEY globally, you do not need to set them per API. However, if you have not enabled them globally, then you can configure them per API
You can replace the {{baseUrl}} with the value directly in the request next to the GET/POST/PATCH/DELETE methods
You can set the X-API-KEY value under the "Headers" for the request
Using the APIs
To execute an API request, simply populate the query parameters and the request body as needed. For guidance on building APIs, refer to the API reference materials for REST and GraphQL.
Note - The Postman client selects (enables) all parameters by default. Please unselect the parameters that are not needed for your API call
You're all set! You can now send your requests using the "Send" option for each API
Last updated
