> For the complete documentation index, see [llms.txt](https://docs.myrspoven.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.myrspoven.com/myrspoven-docs/myrspoven-docs-fr/reference-developpeur/myrspoven-ai-api.md).

# Myrspoven AI-API

myCoreAI échange des données et des consignes avec chaque bâtiment via l’une de plusieurs surfaces — l’API Myrspoven AI propre, une API tierce de fournisseur BMS/SCADA, ou Myrspoven edge exécuté sur site. Cette page décrit chaque surface et renvoie vers la documentation du fournisseur lorsqu’une tierce partie possède l’API.

Pour le modèle conceptuel de flux de données, voir [Prise en main de l’intégration système](/myrspoven-docs/myrspoven-docs-fr/integrations/overview.md).

## Surfaces d’API disponibles

### Myrspoven AI-API (interne)

Le cloud Myrspoven expose une API HTTP propre pour échanger des données du bâtiment avec myCoreAI — lecture des valeurs et consignes actuelles, découverte des signaux, écriture des consignes et téléversement des données de signaux. Un connecteur côté bâtiment s’intègre en appelant cette API ; par exemple, le SmartConnector exécuté dans Schneider EcoStruxure Building Operation (EBO) l’utilise pour lire les consignes optimisées et renvoyer les valeurs du bâtiment.

L’API est documentée dans la **référence OpenAPI** dans cette section, qui fait autorité pour les points de terminaison, les schémas de requête/réponse et l’authentification.

### API BMS/SCADA tierces

Certaines plateformes BMS et SCADA exposent leur propre API HTTP ou API de fournisseur — par exemple Siemens Desigo et Web Port. Lorsqu’une telle API est utilisée, myCoreAI s’intègre via cette API pour découvrir les points, lire les valeurs en temps réel et historiques, et écrire des consignes. L’interface de l’API — points de terminaison, schémas, formats des paramètres — appartient au fournisseur, et **la documentation du fournisseur est la référence faisant autorité**. Le périmètre d’intégration, les identifiants et l’activation sont définis avec Myrspoven pendant l’intégration.

### Myrspoven edge (sur site)

Lorsqu’une connexion via un connecteur ou une API fournisseur accessible n’est pas possible, Myrspoven edge s’exécute dans l’environnement du propriétaire du bâtiment, se connecte localement au BMS et échange des données avec le cloud Myrspoven. L’edge communique uniquement en sortie — il récupère les consignes et les tâches dont il a besoin, puis renvoie les valeurs et les résultats — il n’est donc pas nécessaire d’ouvrir des pare-feu entrants côté bâtiment.

## Authentification et identifiants

L’API Myrspoven AI utilise des jetons porteurs OAuth2. Un ID client et un secret sont émis par Myrspoven et partagés via un canal sécurisé — jamais par e-mail ou chat. La référence OpenAPI documente le flux d’obtention du jeton.

Lorsqu’une API de fournisseur tiers nécessite une authentification (généralement un compte de service pour l’accès en écriture), les identifiants sont créés côté fournisseur et partagés avec Myrspoven via un canal sécurisé. Sur certaines plateformes, les points de terminaison en lecture seule fonctionnent sans authentification. Les écritures nécessitent toujours un compte de service dédié.

Les périmètres et permissions requis sont définis par Myrspoven pour chaque intégration lors de l’onboarding.

## Environnements

Les intégrations sont configurées par bâtiment pour un seul environnement de production. Les changements susceptibles d’affecter un bâtiment en production sont coordonnés avec Myrspoven, et la manière sûre de tester consiste à suspendre les écritures pour le bâtiment en test.

## Gestion des erreurs

Pour l’API Myrspoven AI propre, les codes de réponse et les schémas d’erreur sont documentés dans la référence OpenAPI. Pour les surfaces tierces, la gestion des erreurs suit les conventions du fournisseur qui possède la surface. Lorsque myCoreAI ne peut pas joindre le BMS, il cesse d’écrire des consignes et le BMS continue de fonctionner selon sa propre logique — le bâtiment continue de fonctionner normalement ; seule l’optimisation est mise en pause jusqu’au rétablissement de la connexion.

## Limites de débit

Le rythme de lecture et d’écriture est convenu par bâtiment lors de la mise en service. Les lectures s’exécutent généralement toutes les une à cinq minutes ; les écritures de consignes s’exécutent selon un rythme fixe — généralement toutes les 15 minutes — en suivant la dernière sortie d’optimisation. Lorsqu’un fournisseur tiers impose ses propres limites de débit, elles sont documentées par le fournisseur et ajustées en coordination avec Myrspoven.

## Obtenir de l’aide

Pour des besoins d’intégration allant au-delà des surfaces décrites ici, contactez directement Myrspoven.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.myrspoven.com/myrspoven-docs/myrspoven-docs-fr/reference-developpeur/myrspoven-ai-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
