Introduction
This manual provides a comprehensive guide to using the Cambrionix Recorder API, a powerful tool that enables users to log and record events. The Recorder API offers essential functionality for tracking and monitoring interactions with the hubs and devices, making it an invaluable resource for developers and system administrators.
At the core of the Recorder API is the 'CambrionixRecorderService,' a locally installed service that facilitates seamless integration and communication for event logging. Through this service, users can efficiently retrieve detailed information about event records, monitor hub activity, and manage data logging operations to ensure reliable event tracking.
How the Cambrionix Recorder API Works
The Cambrionix Recorder API communicates via HTTP requests, allowing users to send commands and retrieve information over a network using widely supported protocols such as HTTP and HTTPS. 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 protocols such as HTTP, HTTPS, FTP, and more. Since cURL is widely adopted in scripting and automation, it is ideal for interacting with the Cambrionix Recorder API in scenarios requiring repetitive or automated event logging tasks.
What is cURL?
cURL is a widely used command-line utility that enables sending and receiving data over multiple protocols, including HTTP and HTTPS. Its versatility makes it a popular choice for automating tasks in scripts, system management, and application development. In the context of the Cambrionix Recorder API, cURL allows users to send HTTP requests (e.g., GET, POST, DELETE) to the API and receive structured responses, such as JSON or XML, that can be processed for purposes like monitoring events or retrieving logged information.
Using cURL with the Cambrionix Recorder API
When interacting with the Cambrionix Recorder API, cURL plays a key role in composing and sending the appropriate requests. These requests utilise standard HTTP methods:
| Request Type | Description |
|---|---|
| GET | Retrieves information from a resource (e.g., querying device status or connected devices). |
| POST | Sends data to the API to create or update resources (e.g., sending commands to connected devices). |
| DELETE | Removes or disables specific resources (e.g., disconnecting a device or clearing settings). |
Each request is sent to the API endpoint exposed by the 'CambrionixRecorderService,' and the response is typically returned in a structured format, such as JSON or XML. These responses can be parsed to obtain specific details about recorded events or the status of connected hubs.
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 checking the status of event logs, creating periodic event logging schedules, or managing logging operations. By incorporating cURL into your workflows, you can reduce manual interaction and create automated processes that streamline event tracking and logging.
Prerequisites
Before using the Cambrionix Recorder API, certain requirements must be met to ensure seamless operation. This section outlines the essential components, additional software, and system configurations needed for successful interaction with the API and connected hubs.
To begin using the Cambrionix Recorder API, ensure the following are in place:
Cambrionix Hub API:
Verify that the Cambrionix Hub API, which includes the Recorder API, is installed and correctly configured on your system. During installation, a checkbox for the Cambrionix Recorder Service, part of the Hub API, will be pre-selected. Ensure this option remains selected, as it is essential for using the features outlined in this manual.
To download and install the Cambrionix Hub API, please use the provided link. Additionally, you will find a link to the user manual, which contains extensive information on the API’s different functions along with detailed installation instructions.