> For the complete documentation index, see [llms.txt](https://altec-atls.gitbook.io/api-legacy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://altec-atls.gitbook.io/api-legacy/points-de-terminaison-api/piloter-une-sortie-a-distance/mise-a-letat-souhaite.md).

# Mise à l’état souhaité

{% hint style="warning" %}
**API Legacy — dépréciée mais toujours fonctionnelle.** Pour toute nouvelle intégration, utilisez l'équivalent de l'API v1 : [Mise à l'état souhaité (v1)](https://altec-atls.gitbook.io/altec-atls-api/points-de-terminaison-api/piloter-une-sortie-a-distance/mise-a-letat-souhaite). Les réponses de cette route incluent les headers `Deprecation` et `Link` (RFC 9745) pointant vers ce successeur.
{% endhint %}

{% hint style="danger" %}
L'application doit être activé sur le web-serveur ainsi que les sorties à piloter.

Le produit doit être connecté au serveur d'application.
{% endhint %}

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

{% hint style="warning" %}
Le serveur attend la confirmation du produit (timeout de 5 secondes) avant de retourner le résultat de l'opération.
{% endhint %}

<mark style="color:green;">`POST`</mark> `/setOutputProduct`

**Headers**

| Name          | Value                  |
| ------------- | ---------------------- |
| Content-Type  | `application`          |
| Authorization | `Bearer <accessToken>` |

**Body**

| Name         | Type           | Description                                          |
| ------------ | -------------- | ---------------------------------------------------- |
| productLogin | string         | Identifiant du produit                               |
| numOutput    | number         | <p>Numéro de la sortie<br>Démarre par l'indice 0</p> |
| state        | number: 0 \| 1 | Etat souhaité                                        |

**Request**

{% tabs %}
{% tab title="curl" %}

```bash
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>
}'
```

{% endtab %}

{% tab title="js" %}

```javascript
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);
    }
  });
```

{% endtab %}

{% tab title="node" %}

```javascript
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);
    }
  });
```

{% endtab %}

{% tab title="python" %}

```python
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)
```

{% endtab %}

{% tab title="php" %}
{% code fullWidth="true" %}

```php
<?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);
?>
```

{% endcode %}
{% endtab %}
{% endtabs %}

**Response 200**

{% tabs %}
{% tab title="200" %}
Cas 1 — action effectuée\
OK

Cas 2 — état déjà conforme

```json
{
    "already_set": true
}
```

{% endtab %}
{% endtabs %}

**Response 4xx**

{% tabs %}
{% tab title="401" %}
Le token d'accès est invalide ou a expiré. Une requête de[ ](/api-legacy/authentification/connexion.md)[/refreshToken](/api-legacy/authentification/token-dactualisation.md) est à réaliser afin de récupérer la nouvelle paire de jeton.

```json
{
    "error": "bad-token"
}
```

{% endtab %}

{% tab title="403" %}
La Clé Client n'est pas autorisée à télécommander la sortie. Une requête [/addProduct](/api-legacy/points-de-terminaison-api/ajouter-un-produit.md) est à réaliser pour résoudre l'erreur.

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

{% endtab %}

{% tab title="404" %}
Le productLogin ou le productKey n'existe pas dans notre base de donnée.

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

{% endtab %}

{% tab title="409" %}
Si une requête est en cours, les requêtes supplémentaires sont rejetées jusqu’à la fin du traitement.

```json
{
    "error": "request-already-pending"
}
```

{% endtab %}

{% tab title="422" %}
Paramètres entrants invalides.

```json
{
    "error": "invalid-params"
}
```

{% endtab %}
{% endtabs %}

**Response 5xx**

{% tabs %}
{% tab title="500" %}
Une erreur inattendue s'est produite sur le serveur.

```json
{
    "error": "unknown"
}
```

{% endtab %}

{% tab title="504" %}
Le produit n'a pas confirmé l'exécution de la mise en état souhaité.

```json
{
    "error": "device-timeout"
}
```

{% endtab %}
{% endtabs %}