How to Set Up the Jungle Scout API using Postman

In this article, you will learn how to set up the API using Postman. You can use Postman to familiarize yourself with the Jungle Scout API endpoints, and refine the data sets you need. 

This is what you will need to set up the API Using Postman:

• Postman
• Junglescout API
• Key Name and API Key

How to Generate Your API Key 

Before setting up any endpoints, you will need to generate an API key. 

1. Within the Jungle Scout application, go to your Account Settings page and then click on API Keys.
2. Click on Generate Key . 
3. A pop up window will appear. This is where you will enter in a Key Name. You are only able to use letters, numbers, and underscores. 
   

   

4. Click Generate Key. 
5. A long key will generate. Copy it (click the pages icon  to copy) and save it in a safe place. 

   ⚠️ Warning: Once you have exited out of the API Key window, you will not be able to copy this key again. 

   

6. Once you have exited out of the API key window, you will see the generated API key and key name listed within the table. 
   

Creating your First Request in Postman

Once you have generated your API Key, you will head over to Postman to start a new endpoint. Postman is where you will be entering all of your data from. 

1. Click the plus icon  and select Create A New Collection.
   
   
2. After the collection is show in the Collection panel, click the ellipses   and select Add Request. 
   

   

3. Open the new request, rename your request as needed. It will be helpful to name it as the selected endpoint.

Creating the Headers within Postman

There are three elements needed in the header for the Jungle Scout API: Mime Type, Authentication, and Versioning. You will find the information you need within the JS API documentation.

1. Within your new request, click Headers. This is where you will enter Mime Type, Authentication (key name and API key you generated), and Versioning.
   

   📝 Note: You will need to return to the JS API documentation to  copy the Mime Type and Versioning Code.
   

2. Create a KEY called Content-Type and paste the Mime Type value: application/vnd.api+json.
3. Create a KEY called Authorization and paste in your key name and the API key.
   

   📝 Note: When typing in your key name and API key, it must look like this Key_Name:API Key. There should be NO spaces between the colon and the values.
   

4. Create a KEY called Accept and paste in the Versioning value: application/vnd.junglescout.v1+json.

When setting up subsequent endpoints, you can copy and paste the header information as these won't change between endpoints.

Choosing Your Endpoint

Once you have created your headers within Postman, you are now ready to start using endpoints. The endpoints are exactly like what is offered within the Cobalt UI. 

1. Within your request, choose the operation you want to use. Most Jungle Scout API’s are GET or POST.
   
2. In the Request URL you will type in the base address (https://developer.junglescout.com) followed by the specific endpoint URL.

   🔍 Example: https://developer.junglescout.com/api/keywords/historical_search_volume

   
   
3. Enter the parameters as described in the JS API documentation.

   📝 Note: All the Jungle Scout APIs will require the marketplace parameter.

   

4. (Skip this step if you are not doing a POST or PATCH operation.) If you are using an endpoint with a POST or a PATCH operation, you will need to enter the body as described in the JS API documentation. 
   

   

5. Click Send to send a request to the Jungle Scout API. The response data will show within the response window.