Документация API 
направлена на улучшение взаимодействия пользователя с системой box.ai.tech под управлением ООО ГРЕС и возможности обрабатывать необходимые им запросы с помощью методов GET/POST, используя программный интерфейс приложения (API).  


Общая информация
API (Application Programming Interface) — это набор способов и правил, по которым различные программы общаются между собой и обмениваются данными.  Программный интерфейс выступает посредником между приложениями, сайтами, поисковыми системами и серверами и позволяет им понимать друг друга.  Некоторые области п рименения API:
В языках программирования он помогает функциям корректно общаться друг с другом.  
В операционной системе помогает программам получать данные из памяти или менять настройки ОС.  
В вебе сервисы общаются друг с другом через программный интерфейс

Структура API-запроса включает следующие элементы:  
Конечная точка (endpoint). Адрес, по которому отправляется запрос. Один и тот же объект (ресурс) может иметь несколько конечных точек.  
Метод (method). Указывает тип действия, которое нужно выполнить. Некоторые методы: GET (получение данных), POST (подача данных для обработки), PUT (обновление существующих данных), DELETE (удаление данных).  
Заголовки (headers). В них определяется формат передаваемых данных, спецификация и версия протокола обмена и другая информация, необходимая для корректной обработки запроса. Если для выполнения запроса требуется аутентификация, в заголовке передаются сведения о пользователе — логин, токен и тд.
Тело запроса (body). Содержит данные для обработки, как правило в формате JSON.  

Типы API-запросов:GET. Запрос на получение данных из сервера. Используется для извлечения информации из ресурса без его изменения.  
POST. Запрос на создание нового ресурса на сервере. Используется для отправки данных на сервер для создания нового объекта или выполнения какого-либо действия.  
DELETE. Запрос на удаление существующего ресурса на сервере. Используется для удаления ресурса по его идентификатору или другому уникальному идентификатору.  
PATCH. Запрос на частичное обновление существующего ресурса на сервере. Используется для изменения только некоторых полей или атрибутов ресурса, не затрагивая остальные.  

Разделы 
Работа с API-сервисном box.ai.tech осуществляется по доменному имени «api-box-ai-tech» и содержит следующий URL адрес: «https://api-box-ai-tech.ru».
api-box-ai-tech имеет следующие разделы:
api-box-ai-tech/v1/products – Информация о продуктах, о запусках и работоспособности продукта внутри собственной инфраструктуры.api-box-ai-tech/v1/autorization -- Раздел авторизации и управления сессией.

Начало работы.
Для выполнения API-запросов в систему box.ai.tech необходимо получить уникальный идентификатор (ID), зарегистрировавшись. После успешной авторизации, нужно получить BoxToken (описано ниже), для взаимодействия с системой по продолжительности 40 минут или же выхода из сессии.
BoxToken – токен, необходимый для успешного выполнения клиент-серверного взаимодействия между системами, служит гарантией безопасности передачи и корректной обработки запросов. Формат запросов и ответов : JSON (application/json)

Раздел авторизации и управления сессией.
Запрос на получение BoxToken (api-box-ai-tech/v1/authorization/get_token/GET
Headers Parameters:boxID (string) – Уникальный идентификатор 

Пример запроса: 
{“boxID” : “your_id”}
Пример ответа:
{“boxToken” : “your_BoxToken”,“last_dttm”: “authorization_dttm”}
Response Array:
boxToken (string) – Токен для работы с системой
last_dttm (date) – Время захода в систему

Запрос на остановку активной сессии (api-box-ai-tech/v1/authorization/session_stop/POST)
Сессия сама завершится через 40 минут после получения токена. Метод завершит сессию, если пользователь хочет завершить ее раньше.
Headers Parameters:boxID (string) – Уникальный идентификатор 

Пример запроса: 
{“boxID” : “your_id”}
Пример ответа:
{ “response” : “session_close”}
Response Array:response (string) – Информационная справка о завершении работы сессии.

Раздел информации о продуктах.
Запрос статуса доступности продукта (api-box-ai-tech/v1/products/status/get)
Запрос формирует доступность продуктов для пользователя.
Headers Parameters:boxID (string) – Уникальный идентификатор 

Пример запроса: 
{“boxID” : “your_id”}
Пример ответа:
{“zarplatomer “ : True,“zarplatomer_info”: “Информация о продукте”,“marketbox”: False,“marketbox_info”: “Информация о продукте”,“help”: “справка для подключения продуктов”}
Response Array:zarplatomer (boolean) – Подключен ли продукт «Зарплатомер» 
zarplatomer_info (string) – краткое описание продукта
marketbox (boolean) – Подключен ли продукт «МаркетБокс»
marketbox_info (string) – краткое описание продукта
help (string) – Справка для подключения продуктов

Получение информации о конкретном продукте (api-box-ai-tech/v1/products/info/get)

Запрос о текущем состоянии продукта пользователя.
Headers Parameters:boxID (string) – Уникальный идентификатор 
products (string) – Наименование продукта («зарплатомер»/ «маркетбокс»)

Пример запроса: 
{“boxID” : “your_id”,“products” : “зарплатомер”}

Пример ответа:
{ “organization” : “name”, “is_active”: True, “start_dttm”: 2024-12-01, “cnt_current_user” : 800, “cnt_user_total”: 2431, “uptime”: “12 days”, “info_error”: 0   }
Response Array:organization (string) – Наименование пользователя или организации
is_active (boolean) – активен ли продукт
start_dttm (date) – Дата активации продукта
cnt_current_user (integer) – количество активных пользователей на данный момент
cnt_user_total (integer) – Сколько всего пользователей пользовалось продуктом
uptime (string) – Сколько времени работает продукт
info_error (integer) – Сколько замечено ошибок при работе продукта