Executing a request for an API endpoint - Example with Postman

Requirements

  • API endpoint has been created

  • API key for the endpoint has been created

Step-by-step guide

Proceed as follows to execute a request for an API endpoint (POST) with Postman:

  1. Start the application.

  2. Click the "API Endpoints" area.

    Make sure that the API endpoints view is activated.

    ("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 is displayed.

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

    A message is displayed in the lower right part of the window stating that the API URL has been saved.

  7. Paste the API URL into Notepad.

  8. Go to the "Integration" menu.

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

  10. Select the desired API key.

  11. Press the right mouse button.

    A context menu is displayed.

  12. Select the "Copy API key" entry.

  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. Enter the text "X-API-KEY" in the "KEY" column.

  19. In the "Value" column, add the API key ().

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

  21. Enter the Request JSON body () from the API endpoint.

  22. Click Send.

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

Sort return values - "orby"

If an API endpoint offers the retrieval of multiple data recordsEndpoint - Read multiple data records), you can sort the return values. To do this, add the query parameter "orderby" 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 and descending order using "asc" and "desc". To do this, add a space after the name of the column and then "asc" or "desc". If you do not make an entry, the system will automatically sort in ascending order ("asc").

Example

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

You can also enter several column names and separate them with commas. Sorting is then initially performed according to the first column name and if there are columns with the same name, sorting is performed according to the second parameter within the columns with the same name.

Example

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