Making API Calls

In this guide, you'll learn how to make your first REST API call to UXI using our API Reference Guide . The API Reference Guide provides you with a direct interface for making API calls to UXI from your browser.

Steps to make API calls

Follow these 5 simple steps to make your first API call directly from the API Reference Guide:

1. Select the API Endpoint

Navigate to the API Reference Guide & choose the Agents Get . This is a GET request that retrieves a list of agents from UXI

2. Provide your Access Token

In the Credentials field, paste the access token that you have generated for making API calls to UXI. This token authenticates your request and ensures secure access to the API. If you don't have an access token yet, follow the steps in the Generate Access Token guide to create one.

3. Configure API Parameters(Optional)

Some API endpoints support query parameters to customize your request. You can configure these parameters by filling in the fields under Query Params section for each endpoint.

For example, for the Agents Get API, id, next, and limit can be optionally configured.

4. Making API Request

Once you've set the endpoint, access token, and any necessary API parameters click on the "Try It" button to send the request.

Understanding API Response

Once you've sent your API request, the API Reference Guide will display the response which consists of two parts:

1. HTTP Status Code: This is returned by UXI to indicate the result of your API request
2. Response Body: This contains the actual data or message returned by the API

HTTP Status Code

The status code indicates the outcome of your request. Here are some common status codes you might encounter:

Response Body

The response body contains the actual data returned by the API. Here's an example response for the Get list of Devices endpoint:

{
  "items": [
    {
      "id": "12f03c6d-161b-xxxxxxxxxxxx",
      "serial": "0xxxxxxxxxxxx",
      "name": "TC52AX_A11",
      "modelNumber": "Zebra Technologies TC52AX",
      "wifiMacAddress": "7xxxxxxxxxxxx",
      "ethernetMacAddress": null,
      "notes": "",
      "pcapMode": "light",
      "type": "networking-uxi/agent"
    },
    {
      "id": "5294c2f6-5220-xxxxxxxxxxxx",
      "serial": "exxxxxxxxxxxx",
      "name": "TC52_A14",
      "modelNumber": "Zebra Technologies TC52",
      "wifiMacAddress": "9xxxxxxxxxxxx",
      "ethernetMacAddress": null,
      "notes": "",
      "pcapMode": "light",
      "type": "networking-uxi/agent"
    },
    {
      "id": "74e5fc64-22e4-xxxxxxxxxxxx",
      "serial": "exxxxxxxxxxxx",
      "name": "TC52AX_A14",
      "modelNumber": "Zebra Technologies TC52AX",
      "wifiMacAddress": null,
      "ethernetMacAddress": null,
      "notes": "",
      "pcapMode": "light",
      "type": "networking-uxi/agent"
    },
    {
      "id": "90188420-703e-xxxxxxxxxxxx",
      "serial": "Exxxxxxxxxxxx",
      "name": "mbp",
      "modelNumber": "MacBookPro15,1",
      "wifiMacAddress": null,
      "ethernetMacAddress": null,
      "notes": "",
      "pcapMode": "light",
      "type": "networking-uxi/agent"
    },
    {
      "id": "fd301eb8-67ff-xxxxxxxxxxxx",
      "serial": "fxxxxxxxxxxxx",
      "name": "TC52AX_A13",
      "modelNumber": "Zebra Technologies TC52AX",
      "wifiMacAddress": "7xxxxxxxxxxxx",
      "ethernetMacAddress": null,
      "notes": "",
      "pcapMode": "light",
      "type": "networking-uxi/agent"
    }
  ],
  "count": 5,
  "next": null
}

You have now learned how to use our API Reference Guide to make API calls to UXI. We encourage you to explore more API endpoints available in the Reference Guide. Each endpoint has detailed documentation to help you understand what it does and how to use it effectively. Start with simple GET requests and gradually explore more advanced endpoints.

For advanced users, our next guide covers how to use UXI Postman Collection, which allows you to test & automate API calls efficiently