API ( Swagger )

API settings can limit what actions (Create, Read, Delete…) can be performed based on the API key. Each key has specific permission, allowing or restricting data, while preventing updates or deletions. This is important for machine-to-machine communication, ensuring that each key can only access the designated operations. Additionally, API keys can be set up to control access to specific groups or devices, ensuring that only authorized machines can interact with those devices. This helps prevent unauthorized use of the API.

access the API DOCUMENTATION here: https://app.gitbook.com/o/DKrl40rifuf7Bl8WIqXK/s/fEQ6KpTjmszWVWQqgcEa/~/changes/211/.pdf-files-for-download/technical-.pdf

Swagger API Introduction

Steps to Swagger API

1. Navigate to Administration Menu:

   • Ensure you are in the Cockpit menu, then click on Administration.

2. Access API Section:

   • Click on API to be redirected to Swagger.

3. Authorize API Access:

   • In Swagger, click on the Authorize button.

4. Enter API Key:

   • Provide the API key to complete the authentication process.