Introduction

This guide provides step by step descriptions of how to deal with SPARQUE in Postman based on a demo Postman collection.

References

• Concept - Implementing Search with Sparque

Download Collection

You can download the Postman collection here:

• Postman collection (JSON)

Import Collection

To import the Postman collection, follow these steps:

1. In Postman, click on Import in the Workspace section.

2. Add the downloaded file.

3. Click on the Import button under Import Elements.

Get Token within Postman

To get an access token within Postman, follow these steps:

1. Create a new request for the Spinque Query API call you want to do, for example “https://rest.spinque.com/4/my-workspace/api/my-api/e/my-endpoint/results?config=default&count=30”.

2. Under Authorization, click the Type drop-down and select “OAuth 2.0”.

3. Make sure Add auth data to is set to “Request Headers”.

4. To the right, scroll down to Configure New Token.

5. Under the Configuration Options tab, add a name for your new token. This can be anything you want.

6. For Grant Type, select “Client Credentials”.

7. For Access Token URL, fill in “https://login.spinque.com/oauth/token”.

8. Fill in your Client ID and Client Secret in the next two fields.
   You can find them within the member settings - system user.

9. Leave the Scope empty.

10. Set Client Authentication to “Send client credentials in body”.

11. Open the Advanced Options tab.

12. Set Audience to “https://rest.spinque.com/”.

13. Click the Get New Access Token button and, if successful, click Proceed and then Use Token.

14. Now click Send to send the request to the Spinque Query API.

The token has a validation of 24hr. After this time you will need to repeat step 13 and step 14.

Change Variables

For changing variables, follow these steps:

1. Click on the collection “Demo”.

2. Go to the tab Variables.

3. Change the variables in the things you need, for example

   1. workspace (the name of your workspace, this is used for the API path)

   2. API (the name of your API set which you configured within the workspace)

   3. keyword (in most cases the word which is used for search)

   4. etc

Test All APIs at the Same Time

You can test all APIs at once. To do so, follow these steps:

1. Click on your collection (for example “Demo”).

2. Navigate to tab Runs.

3. Click on Run Collection.

4. Click on the button Run {{your collection name}} which is in the demo example Run Demo.

Option

By default, Postman will collect all HTTP statuses, it will not store the response itself (because of performance). You can change this setting:

1. Before running your collection (Run Demo), click on Advanced settings.

2. Make sure Save responses is set.

3. Click on Run Demo.