Mise à l’état souhaité

L'application doit être activé sur le web-serveur ainsi que les sorties à piloter.

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

Basculer la sortie du produit en fonction de l'état désiré. Si on veut activer l'état alors qu'il est déjà activé la commande renvoie OK mais la sortie ne bascule pas.

Sortie en Marche/Arrêt
- L'état de la sortie bascule si l'état souhaité est différent de l'état présent.
Sortie en Impulsionnel
- 0: rien ne se passe
- 1: génère l'impulsion de la durée programmé sur le produit

Le serveur attend la confirmation du produit (timeout de 5 secondes) avant de retourner le résultat de l'opération.

POST /setOutputProduct

Headers

Name

Value

Content-Type

application

Authorization

Bearer <accessToken>

Body

Name

Type

Description

productLogin

string

Identifiant du produit

numOutput

number

Numéro de la sortie Démarre par l'indice 0

state

number: 0 | 1

Etat souhaité

Request

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

const url = 'https://ovh-backend.altec-ts.fr/api/setOutputProduct';
const data = {
  productLogin: <your_product_login>,
  numOutput: <your_num_output>,
  state: <your_state>
};
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) {
      // Gérer les réponses non 200
      return response.json().then(errData => {
        console.log("status:", response.status);
        console.log("message:", errData.error || "An error has occurred");
      });
    }
    console.log('OK');
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      console.log("message: No response received from server");
    } else {
      console.log('error.message:', error.message);
    }
  });

const axios = require("axios");

// Définir les données et les en-têtes
const url = 'https://ovh-backend.altec-ts.fr/api/setOutputProduct';
const data = {
  productLogin: <your_product_login>,
  numOutput: <your_num_output>,
  state: <your_state>
};
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('OK');
  })
  .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);
    }
  });

import requests

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

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

# 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:
    print("OK")
else:
    print(f"Erreur {response.status_code} :", response.text)

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

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

// 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) {
        echo "OK\n";
    } else {
        echo "Erreur HTTP {$httpCode} : " . $response . "\n";
    }
}

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

Response 200

Cas 1 — action effectuée OK

Cas 2 — état déjà conforme

{
    "already_set": true
}

Response 4xx

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"
}

Response 5xx

Une erreur inattendue s'est produite sur le serveur.

{
    "error": "unknown"
}

PrécédentBascule de l'état SuivantRécupérer un état système

Mis à jour il y a 1 mois