D-BOX HaptiSync API
L'API HaptiSync permet à toute application tierce de contrôler par programmation l'expérience haptique D-BOX.
Grâce à des appels HTTP RESTful, elle met à disposition tous les paramètres normalement gérés par le moteur D-BOX Motion Engine.
Cela ouvre la voie à deux grandes catégories d'intégration :
-
Intégrations logicielles : logiciels de formation, logiciels de gestion de sim center, etc.
-
Intégrations de périphériques matériels : contrôleurs physiques tels que boîtiers à boutons, Stream Decks, claviers, etc.
IMPORTANT :
-
HaptiSync Center 1.3.0 est la version minimale requise pour que l'API HaptiSync soit fonctionnelle.
- L'accès à distance via le réseau local (LAN) et l'authentification via l'API nécessitent HaptiSync Center 1.3.3 ou une version ultérieure. En cas d'accès à distance, tous les terminaux sécurisés doivent être authentifiés à l'aide d'une clé API transmise dans l'en-tête de requête HTTP « X-API-Key ».
Accès local ou à distance
L'API HaptiSync prend en charge deux modes d'accès : local et à distance.
| Local | A distance | |
| Port | 42010 | 42011 |
| Protocole | HTTP | HTTPS |
| Addresse | localhost uniquement |
Toutes les interfaces réseau (LAN) |
| Authentification | Non requise | Requise: X-API-Key: <key> |
| Swagger UI | http://localhost:42010/index.html | https:// <IPAddress>:42011 |
Avertissement de sécurité du navigateur (version à distance uniquement)
Lorsque vous accédez à la version à distance de l'interface, il est normal que le navigateur affiche un avertissement du type « Votre connexion n'est pas privée ». Ce message s'affiche car le certificat utilisé est auto-signé et n'est pas émis par une autorité de certification reconnue par le navigateur. Ce comportement est normal et n'indique pas que la connexion est compromise. Cet avertissement ne concernant pas la version locale. Pour continuer :
- Cliquez sur « Avancé »
- Cliquez sur le Link « Accéder à [adresse IP] (non sécurisé) » qui s'affiche
Gestion des clés API
Les clés API sont gérées exclusivement depuis l'interface d'administration locale. Les clients distants ne peuvent ni créer ni révoquer de clés. Pour plus de détails sur la gestion des clés, consultez la documentation Swagger (http://localhost:42010/index.html).
Fonctionnalités clés:
-
Gestion des codes haptiques de jeu: Un code haptique de jeu (Game Haptic Code) est une ressource haptique de D-BOX liée à un jeu spécifique (par exemple, Assetto Corsa). L'API vous permet de répertorier tous les codes haptiques installés sur le PC, de cibler le code haptique de jeu en cours d'exécution et d'ajuster ses deux paramètres globaux : Main Level (%) et Motion/Vibration balance (%).
-
Contrôle des profils par jeu: Chaque code haptique de jeu prend en charge plusieurs profils (par exemple, Default, Intense, etc.). L'API vous permet de les répertorier, d'en sélectionner un, de les parcourir dans l'ordre et d'ajuster les paramètres individuels de chaque profil, tels que l'accélération, l'inclinaison, la suspension, les vibrations du moteur et les impacts.
-
Contrôle du système haptique: Les systèmes haptiques D-BOX connectés peuvent être répertoriés et réglés individuellement. Les paramètres contrôlables comprennent le niveau d'intensité du mouvement, le niveau d'intensité des vibrations, le :"mute" et "unmute" et les curseurs liés (mouvement et vibrations verrouillés ensemble).
-
Changement de mode d'expérience: Quatre modes HaptiSync sont disponibles : D-BOX Coded Gaming, D-BOX Coded Video, Adaptive Gaming et Adaptive Audio. L'API vous permet de lire le mode actif et de basculer entre eux.
-
Commutateur haptique global: Un contrôle unique pour activer ou désactiver simultanément toutes les fonctions haptiques sur l'ensemble des systèmes haptiques D-BOX connectés. Utile pour un contrôle rapide de l'activation/désactivation sans avoir à modifier les paramètres de chaque appareil.
-
Vérifications de l'état et de la connectivité: Deux contrôles permettent aux intégrateurs de vérifier que l'API est en cours d'exécution (ping) et qu'elle peut atteindre correctement le service D-BOX Motion Engine.
Cas d'utilisation
Voici quelques exemples d'utilisation de l'API :
-
Logiciel de gestion de sim centers : les logiciels de gestion de centres de simulation peuvent contrôler les paramètres haptiques directement depuis leur propre interface, en appliquant la configuration appropriée au début de chaque session et en la réinitialisant à la fin, sans jamais à ouvrir l'application D-BOX.
-
Logiciels de formation et de simulation : les plateformes de formation peuvent contrôler le comportement haptique directement depuis leur propre logiciel, en ajustant l’intensité et en changeant de profil sans aucune interaction manuelle avec l’application D-BOX.
-
Intégration Stream Deck / Button Box : les opérateurs ou les utilisateurs finaux peuvent associer des boutons physiques à des appels API pour passer d’un profil à l’autre, ajuster l’intensité des mouvements ou des vibrations, ou mettre le siège en sourdine instantanément pendant une session.
REMARQUES :
-
Lors de l'utilisation de l'accès à distance, les points de terminaison de vérification du statut de santé (/api/v1/health/*) nécessitent actuellement une clé API, bien qu'ils soient censés rester accessibles au public pour les vérifications de base du statut du service. Ce problème sera résolu dans une prochaine version.
-
L'état de la connexion de l'HaptiSync API peut être vérifié à tout moment via la section Stream Deck Integration dans HaptiSync Center.
