Postman is an API platform for developers to design, build, test and iterate their APIs. Spark makes it easy to test the generated APIs on Postman. Here is how we recommend it can be done!
Upload the following service to Spark to follow along!
cURL is a computer software project providing a library (libcurl) and command line tool (curl) for transferring data using various network protocols. Start by exporting the cURL command from Spark to import the API data into Postman.
Go to the API Tester page for the target service.
Click on the Integration tab select Code snippet and choose the curl - cURL option.
At the bottom of the page is the option to copy the snippet or download.
Open the Postman application.
Click on Import in the workspace.
If the cURL was downloaded as a file, drag the file into Drop anywhere to import.
If the cURL was copied as text, paste the text into the textbox.
Spark provides multiple methods of authentication to be added to an API request.
Retrieve the bearer token here, see Authorization - Bearer token.
Create a new Authentication header and paste the bearer token from the previous step.
OR Open the API in Postman and open Authentication tab.
Select Bearer token as option.
Remove the word Bearer preceding the Bearer Token paste the field.
x-synthetic-keyGenerate the API key using the procedure mentioned in Authorization - API keys.
Open the API in Postman and open the Headers tab.
Ensure the x-tenant-name is populated.
Create a new header called x-synthetic-key and use the key that was previously generated.
The API request can be sent to Spark by clicking the Send button.
The API response can be checked using the Body tab of the interface.
The response codes (HTTP status codes) generated by Spark can be referenced in Execute API (v3).
Last updated