Consulter les appareils et utiliser les opérations autorisées
Les opérations sur les appareils utilisent la famille de routes /v1/device au singulier. Utilisez la session API et les permissions attribuées au compte.
POST
/v1/device/list
Lister les appareils
Nécessite can_view_devices. Transmettez les filtres et la pagination dans le corps JSON. La réponse contient success, devices et count. Les résultats non vides comprennent aussi next_cursor.
Corps de la requête JSON
| Paramètre | Type | Description |
|---|---|---|
| page | integer | Numéro de page; valeur par défaut : 1. |
| page_limit | integer | Résultats par page; valeur par défaut : 25. |
| search | string | Texte de recherche facultatif. |
| cursor_id | integer | Utilisez next_cursor pour obtenir le lot suivant, plus ancien. |
Exemple de requête
curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/device/list" \
-H "SessionID: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"page":1,"page_limit":25}'Exemple de réponse
Exemple sans appareil correspondant.
{
"success": true,
"devices": [],
"count": 0
}
POST
/v1/device
Consulter un appareil
Transmettez l’identifiant numérique de l’appareil dans le corps JSON. Une réponse réussie contient success et device.
Corps de la requête JSON
| Paramètre | Type | Description |
|---|---|---|
| id | integer | Identifiant de l’appareil; remplacez la valeur d’exemple. |
Exemple de requête
curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/device" \
-H "SessionID: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"id":123}'Configuration et commandes de voie
- PUT /v1/device crée un appareil et nécessite can_add_devices.
- PATCH /v1/device/config modifie la configuration et nécessite can_edit_devices.
- POST /v1/device/open et /v1/device/close transmettent une commande de voie avec id dans le corps JSON et nécessitent can_control_devices. Une réponse API réussie indique la commande; elle ne prouve pas le mouvement physique de la barrière.