# Introduction

L'objectif de cette documentation est de présenter l'interface de programmation d'application (API) disponible via le système de surveillance batterX liveX.

Le service web batterX liveX permet d'accéder aux données stockées dans la base de données locale `SQLite3`.

Cette documentation fournit des informations sur les caractéristiques techniques de l'API et décrit chaque API avec ses paramètres, ses formats et d'autres détails.

L'API batterX liveX permet à d'autres applications logicielles d'accéder à la base de données de son système de surveillance à des fins d'analyse des données, de gestion des onduleurs, d'affichage des données du système dans d'autres applications, etc.

## Accès à l'API

Le point de terminaison de l'API local est accessible uniquement via le protocole **`HTTP`**.

Le point de terminaison de l'API est : **`http://LIVEX_IP_ADDRESS/api.php`**\
\&#xNAN;*où `LIVEX_IP_ADDRESS` est l'adresse IP de votre batterX liveX.*

Le format et les paramètres de la requête sont spécifiés pour chaque API.\
Le format de réponse est **`JSON`** (`application/json`).

## Limitation d'utilisation

Il n'y a pas de limite au nombre de requêtes API que vous pouvez effectuer, mais en raison des limitations de l'architecture de la base de données SQLite3, nous vous recommandons de ne pas dépasser **1 requête API par seconde**.