Introduction

This manual serves as a comprehensive guide to using the Cambrionix Connect Authentication API, a robust, cloud-based API that provides secure and scalable authentication capabilities for managing access within the Cambrionix Connect platform. The Authentication API is vital for implementing secure user management, ensuring seamless integration of login, registration, and access control functionalities.

As a cloud-based service, the Authentication API ensures real-time access and updates, providing flexibility and scalability to meet the demands of both small teams and large, distributed organisations. Users can efficiently authenticate, authorise, and manage permissions across their network, ensuring data security and streamlined access control processes.

The Authentication API simplifies secure access by providing features like token-based authentication, user role management, and permission-based access to resources. This functionality supports organisations in maintaining robust security practices while ensuring a smooth user experience.

How the API Works

The Cambrionix Connect Authentication API operates via HTTPS requests, allowing users to securely send authentication commands and retrieve access information over a network. This platform-agnostic API is compatible with a range of tools, including web browsers, command-line utilities, and custom-built applications, making it highly versatile and adaptable to different environments.

To support these interactions, this manual includes examples using cURL (Client URL), a powerful command-line tool widely used for automating HTTPS requests and transferring data securely. With its flexibility and scripting capabilities, cURL is particularly well-suited for interacting with the Authentication API, especially for repetitive or automated processes like token generation, user management, and access control configurations.

What is cURL?

The Cambrionix Connect Authentication API requires HTTPS for secure communication, ensuring data integrity and confidentiality during interactions. cURL, a powerful command-line tool, is widely used for interacting with APIs, enabling users to securely send and receive data over protocols like HTTPS.

With cURL, users can automate interactions with the Authentication API, performing HTTP requests such as GET for retrieving user details, POST for user registration, PUT for updating permissions, and DELETE for revoking access. Structured responses from the API can be easily processed, supporting a variety of use cases.

This flexibility makes cURL an indispensable tool for scripting authentication workflows, managing system security, and integrating access controls into application development.

Using cURL with the Cambrionix Locations API

When interacting with the Cambrionix Connect Authentication 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 Authentication 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.