Récupérer un état système

L'application doit être activé sur le web-serveur ainsi que les états système souhaités.

Le produit doit être connecté au serveur d'application.

Récupère les divers état d'un produit, ils doivent être configurés à partir du web-serveur du produit dans la page Programmation > Application. Cela concerne :

• Entrées

  • le nombre d'entrée dépend du nombre disponible sur le produit

    • 0: réarmée

    • 1: déclenchée

Si votre produit comporte une entrée Marche/Arrêt l'indice de l'entrée est à 0 sinon l'indice commence à 1.

• Sorties

  • le nombre de sortie dépend du nombre disponible sur le produit

    • 0: désactivée

    • 1: activée

• Défauts - numéro dépend si disponible sur le produit

  • 0: Défaut alimentation

    • 0: ok

    • 1: faible

  • 1: Défaut Tension secteur

    • 0: présente

    • 1: absente

  • 2: Défaut Batterie

    • 0: ok

    • 1: faible

  • 3: non utilisée

  • 4: Défaillance Batterie

    • 0: fin

    • 1: présente

Un état à -1 signifie que le produit n'a pas envoyé son état au serveur d'application malgré le fait qu'il est bien envoyé sa trame de configuration.

POST /getProductStates

Headers

Name	Value
Content-Type	Application
Authorization	Bearer <accessToken>

Body

Name	Type	Description
productLogin	string	Identifiant

Request

curl

curl -X POST https://ovh-backend.altec-ts.fr/api/getProductStates \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_access_token" \
-d '{
  "productLogin": <your_product_login>,
}'

js

const url = 'https://ovh-backend.altec-ts.fr/api/getProductStates';
const data = {
  productLogin: '<your_product_login>',
};
const headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer your_access_token'
};

fetch(url, {
  method: 'POST',
  headers,
  body: JSON.stringify(data)
})
  .then(response => {
    if (!response.ok) {
      // Lire la réponse JSON en cas d'erreur
      return response.json().then(errData => {
        console.log("status:", response.status);
        console.log("message:", errData.error || "An error has occurred");
        throw new Error(errData.error || "An error has occurred");
      });
    }
    // Lire la réponse JSON en cas de succès
    return response.json();
  })
  .then(jsonData => {
    console.log('Réponse JSON :', jsonData);
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      console.log("message: No response received from server");
    } else {
      console.log('error.message:', error.message);
    }
  });

node

const axios = require("axios");

// Définir les données et les en-têtes
const url = 'https://ovh-backend.altec-ts.fr/api/getProductStates';
const data = {
  productLogin: <your_product_login>,
};
const headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer your_access_token'
};

// Effectuer la requête POST
axios.post(url, data, { headers })
  .then(response => {
    console.log('Réponse JSON :', response.data);
  })
  .catch(error => {
    if (error.response) {
      // Server responded with a status code outside the 2xx range
      console.log("status:", error.response.status);
      console.log("message:", error.response.data.error || "An error has occurred");
    } else if (error.request) {
      // Request was made but no response received
      console.log("message: No response received from server");
    } else {
      // Something happened in setting up the request
      console.log('error.message:', error.message);
    }
  });

python

import requests
import json  # Ajout nécessaire

# URL de l'API
url = "https://ovh-backend.altec-ts.fr/api/getProductStates"

# Données pour la requête
data = {
    "productLogin": <your_product_login>,
}

# En-têtes de la requête
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer your_access_token"
}

# Effectuer la requête POST
response = requests.post(url, json=data, headers=headers)

# Afficher la réponse
if response.status_code == 200:
     try:
        print("Réponse JSON :", json.dumps(response.json(), indent=2))
    except ValueError:
        print("La réponse n'est pas au format JSON :", response.text)
else:
    print(f"Erreur {response.status_code} :", response.text)

php

<?php
// URL de l'API
$url = "https://ovh-backend.altec-ts.fr/api/getProductStates";

// Données à envoyer
$data = [
    "productLogin" => <your_product_login>,
];

// Encodage des données en JSON
$jsonData = json_encode($data);

// Initialisation de cURL
$ch = curl_init($url);

// Configuration des options cURL
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer your_access_token"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Exécution de la requête
$response = curl_exec($ch);

// Vérification des erreurs
if (curl_errno($ch)) {
    echo "Erreur cURL : " . curl_error($ch) . "\n";
} else {
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($httpCode == 200) {
        $decoded = json_decode($response, true);
        if (json_last_error() === JSON_ERROR_NONE) {
            echo "Réponse JSON :\n";
            echo json_encode($decoded, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n";
        } else {
            echo "Réponse non-JSON : " . $response . "\n";
        }
    } else {
        echo "Erreur HTTP {$httpCode} : " . $response . "\n";
    }
}

// Fermeture de la session cURL
curl_close($ch);
?>

Response

200

En supposant qu'une entrée, une sortie, et un défaut sur la partie application du web-serveur du produit est activée, le serveur renvoie un json sous le format suivant :

{
    entrees:{
        <numero_entree>: <-1|0|1|>
    },
    sorties:{        
        <numero_sortie>: <-1|0|1>
    },
    defauts:{
        <numero_defaut>: <-1|0|1>
    }
}

401

Le token d'accès est invalide ou a expiré. Une requête de /refreshToken est à réaliser afin de récupérer la nouvelle paire de jeton.

{
    "error": "bad-token"
}

403

La Clé Client n'est pas autorisée à télécommander la sortie. Une requête /addProduct est à réaliser pour résoudre l'erreur.

{
    "error": "user-not-allowed"
}

404

Le productLogin ou le productKey n'existe pas dans notre base de donnée.

{
    "error": "product-not-found"
}

422

Paramètres entrants invalides.

{
    "error": "invalid-params"
}

500

Le token d'accès est invalide ou a expiré. Une requête de /refreshToken est à réaliser afin de récupérer la nouvelle paire de jeton.

{
    "error": "bad-token"
}