Introduction

This manual provides a comprehensive guide to using the Cambrionix Locations API, a powerful, cloud-based API that enables users to create, manage, and assign locations to hardware within the Cambrionix Connect software. The Locations API is essential for efficiently organising and maintaining a clear structure of your hardware assets, ensuring that devices, hubs, and computers can be easily located and managed across your entire fleet, regardless of geographical location.

As a cloud-based service, the Locations API offers the advantage of real-time access and updates from anywhere, ensuring flexibility and scalability. Users can seamlessly create specific locations for pieces of hardware, making it straightforward to track, manage, and manage them. This functionality allows for improved inventory management, streamlined maintenance, and enhanced troubleshooting by providing clear insights into the physical and network location of each device.

Whether managing a small setup or a large, geographically dispersed network of devices, the Locations API ensures efficient, location-based control and oversight.

How the API Works

The Cambrionix Locations API communicates via HTTPS requests, allowing users to send commands and retrieve information over a network. This platform-agnostic API is compatible with a wide range of tools, including web browsers, command-line utilities, and custom applications.

To facilitate these interactions, this manual provides examples using cURL (Client URL), a powerful command-line tool used to automate HTTP requests and transfer data over HTTPS protocols. Since cURL is widely adopted in scripting and automation, it is ideal for interacting with the Cambrionix Locations API in scenarios requiring repetitive or automated tasks.

What is cURL?

The Cambrionix Locations API requires HTTPS for secure communication. cURL is a versatile command-line tool commonly used to interact with APIs, enabling users to send and receive data over various protocols, including the required HTTPS. With cURL, users can easily automate interactions with the Cambrionix Locations API, making HTTP requests (such as GET, POST, DELETE) and handling structured responses. This flexibility is invaluable in scripting, system management, and application development workflows.

Using cURL with the Cambrionix Locations API

When interacting with the Cambrionix Locations API, which uses a RESTful architecture, cURL plays a key role in composing and sending the appropriate requests. This approach ensures efficient and structured communication with the API over HTTPS. cURL facilitates seamless integration, making it easier to automate tasks and retrieve structured responses from the API.

Request Type	Description
GET	Retrieves information from a resource (e.g., querying locations).
POST	Sends data to the API to create or update resources (e.g., add a new location).
DELETE	Removes or disables specific resources (e.g., remove a location).
PATCH	Updates exsiting data (e.g. change a location)

Each request is sent to the API endpoint and the response is returned in a structured JSON format.

Automating Interactions with cURL

Because cURL can be integrated into shell scripts and other automation tools, it is highly effective for automating routine tasks, such as setting location information for new hardware. By incorporating cURL into your workflows, you can reduce manual interaction and create automated processes that streamline assinging and editing location information.

Prerequisites

Before using the Cambrionix Locations API, certain requirements must be met to ensure seamless operation.

• Cambrionix Connect License: A valid Cambrionix Connect License is required for accessing and using the API’s full functionality.

• As the API is cloud-based, internet access is required, with a stable network connection needed for it to function properly.