The GET method is the simplest method used in Postman to request data from MiX Integrate and does not use a message body to send additional information when requesting information. You only need to supply a URL in the request to execute the method. In some GET methods, you also need to supply the URL with parameters. See below for an example of where you request the organization groups that you have access to:
- Now that you have authenticated with the MiX Integrate identity server with the relevant environment (UAT as in the example), we need to start requesting data from the same environment by supplying the “UAT” MiX Integrate domain URL, followed by the API endpoint path.
Example endpoint in Swagger:
Using the endpoint in Postman:
- Use the URL as indicated above. Click the blue “Send” button on the right-hand side and retrieve the information, which will be displayed in the “Response Body” in JSON format:
Screen 2
- Some GET methods require you to supply some additional parameters in the URL, and this will be indicated with curly brackets "{ }” for the applicable endpoints on the Swagger page. This means it will need to be replaced with an actual value, which is often indicated with a short description, for example:
Example endpoint in Swagger:
- To display this in action, return to Postman and replace the {groupId} with an actual value from the screenshot in screen 2 and click send to execute the request (the endpoint retrieves the sites for the groupId supplied):