Execute a Request for an API Endpoint - Example Using Postman

Requirements

• API endpoint created

• An API key for the endpoint has been created

Step-by-Step

To send a request to an API endpoint (POST) using Postman, follow these steps:

1. Launch the application.

2. Click the "API Endpoints" section.

   Make sure that the API endpoints view is enabled.

   ("View" > "API Endpoints")

3. Select the endpoint for which you want to execute the request.

4. Press the right mouse button.

5. A context menu appears.

6. Select the "Copy endpoint URL to clipboard" option.

   

   A message indicating that the API URL has been saved appears in the lower-right corner of the window.

   

7. Paste the API URL into Notepad.

8. Go to the "Integration" menu.

9. Click "Application API" > "API Keys."

10. Select the desired API key.

11. Press the right mouse button.

    A context menu appears.

12. Select the "Copy API Key" option.

13. Paste the API key into Notepad.

14. Launch Postman.

15. Select "POST" as the method.

16. Paste the API URL into the field next to the method ().

17. Go to the "Headers" tab.

18. In the "KEY" column, enter the text "X-API-KEY."

19. Enter the API key in the "Value" column ().

    

20. Go to the "Body" tab (), select the "raw" option (), and choose JSON ().

21. Retrieve the request JSON body () from the API endpoint.

    

22. Click Send.

    The request is executed, and the return values of the request are displayed.

    

Sorting Return Values - "oderby"

If an API endpoint allows you to retrieve multiple records (Endpoint - Read Multiple Records), you can sort the return values. To do this, append the "orderby" query parameter and the name of the column (database field) by which you want to sort to the endpoint URL.

Example

https://localhost:1340/api/app/32B637794D280C61D14356C132A3EF83CAFEE308/stores?orderby=storemanager

You can sort the return values in ascending or descending order using "asc" and "desc." To do this, add a space after the column name, followed by "asc" or "desc." If you do not specify a sort order, the results will be sorted in ascending order ("asc") by default.

Example

https://localhost:1340/api/app/32B637794D280C61D14356C132A3EF83CAFEE308/stores?orderby=storemanager desc

You can also specify multiple column names, separated by commas. The data is then sorted first by the first column name, and if there are columns with the same name, it is sorted by the second parameter within those columns.

Example

https://localhost:1340/api/app/32B637794D280C61D14356C132A3EF83CAFEE308/stores?orderby=storemanager,storecity desc