Introduction

This manual serves as a comprehensive guide to using the Cambrionix Connect Hardware API, a powerful cloud-based API designed for managing organisation hubs, devices, and hardware groups within the Cambrionix Connect platform. The Hardware API is essential for enabling seamless integration, monitoring, and control of connected hardware, ensuring efficient device management across various environments.

As a cloud-based service, the Hardware API provides real-time access and updates, offering the flexibility and scalability needed for both small teams and large, distributed organisations. Users can effectively manage hubs, assign devices to hardware groups, monitor hardware status, and configure firmware updates, streamlining hardware operations while maintaining control over their network.

The Hardware API simplifies hardware management by offering features such as device grouping, hub administration, and firmware management. These capabilities support organisations in maintaining an organised, efficient, and scalable hardware infrastructure within the Cambrionix Connect ecosystem.

How the API Works

The Cambrionix Connect Hardware API operates via HTTPS requests, enabling users to securely manage organisation hubs, devices, and hardware groups over a network. This platform-agnostic API is compatible with a variety of tools, including web browsers, command-line utilities, and custom-built applications, making it highly adaptable to different operational environments.

To support these interactions, this manual includes examples using cURL (Client URL), a powerful command-line tool commonly used for automating HTTPS requests and securely transferring data. With its flexibility and scripting capabilities, cURL is particularly useful for interacting with the Hardware API, especially for automating processes such as device registration, hub management, hardware grouping, and firmware updates.

What is cURL?

The Cambrionix Connect Hardware API requires HTTPS for secure communication, ensuring data integrity and confidentiality when managing hubs, devices, and hardware groups. cURL, a powerful command-line tool, is widely used for interacting with APIs, allowing users to securely send and receive data over HTTPS.

With cURL, users can automate interactions with the Hardware API, performing HTTP requests such as GET to retrieve device details, POST to register new hardware, PUT to update configurations, and DELETE to remove devices or hubs. The API’s structured responses can be easily processed, enabling efficient hardware management and integration.

This flexibility makes cURL an essential tool for scripting hardware management workflows, automating device administration, and seamlessly integrating hardware control into broader application development.

Using cURL with the Connect Hardware API

When interacting with the Cambrionix Connect Hardware 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	Fetches data from the server
POST	Sends data to the server to create a new resource
DELETE	Removes a resource from the server
PATCH	Sends data to partially update an existing resource
PUT	Sends data to update or replace an existing resource, or create it if it does not exist

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 Connect Hardware 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.