Introduction
This manual provides a comprehensive guide to using the Cambrionix Connect Workflows API, a versatile, cloud-based API that enables users to create, manage, and execute workflows within the Cambrionix Connect software. The Workflows API is essential for automating and streamlining operational processes, ensuring that tasks involving devices, hubs, and computers are efficiently coordinated and executed across your entire fleet.
As a cloud-based service, the Workflows API offers real-time access and updates from anywhere, ensuring flexibility and scalability. Users can seamlessly design and execute workflows tailored to specific tasks, making it easy to automate repetitive actions, track progress, and manage processes. This functionality enhances operational efficiency, simplifies maintenance, and improves troubleshooting by providing clear insights into workflow performance and execution details.
How the API Works
The Cambrionix Connect Workflows API communicates via HTTPS requests, enabling users to send commands and retrieve information over a network. This platform-agnostic API is compatible with various tools, including web browsers, command-line utilities, and custom applications.
To support these interactions, this manual includes examples using cURL (Client URL), a widely adopted command-line tool for automating HTTP requests and transferring data over HTTPS protocols. With its versatility and scripting capabilities, cURL is ideal for interacting with the Cambrionix Connect Workflows API, particularly for repetitive or automated tasks.
What is cURL?
The Cambrionix Connect Workflows API requires HTTPS for secure communication. cURL, a powerful command-line tool, is commonly used to interact with APIs, allowing users to send and receive data over protocols like HTTPS. With cURL, users can automate interactions with the Cambrionix Connect Workflows API, performing HTTP requests (such as GET, POST, DELETE) and processing structured responses. This flexibility makes cURL an invaluable tool for scripting, system management, and application development workflows.
Using cURL with the Cambrionix Locations API
When interacting with the Cambrionix Connect Workflows 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 Workflows 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.