> 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-pl/dokumentacja-dla-deweloperow/myrspoven-ai-api.md). # Myrspoven AI-API myCoreAI wymienia dane i wartości zadane z każdym budynkiem za pośrednictwem jednego z kilku interfejsów — pierwszoplanowego Myrspoven AI-API, zewnętrznego API dostawcy BMS/SCADA lub Myrspoven edge działającego lokalnie. Ta strona opisuje każdy z tych interfejsów i odsyła do dokumentacji dostawcy tam, gdzie API należy do strony trzeciej. Aby zobaczyć koncepcyjny model przepływu danych, zobacz [Przegląd integracji](/myrspoven-docs/myrspoven-docs-pl/integracje/overview.md). ## Dostępne interfejsy API ### Myrspoven AI-API (pierwszoplanowe) Chmura Myrspoven udostępnia pierwszoplanowe HTTP API do wymiany danych budynkowych z myCoreAI — odczytu bieżących wartości i wartości zadanych, wykrywania sygnałów, zapisywania wartości zadanych oraz przesyłania danych sygnałowych. Łącznik po stronie budynku integruje się, wywołując to API; na przykład SmartConnector działający w Schneider EcoStruxure Building Operation (EBO) używa go do odczytu zoptymalizowanych wartości zadanych i przekazywania wartości budynku z powrotem. API jest opisane w **dokumentacji referencyjnej OpenAPI** w tej sekcji, która jest nadrzędnym źródłem informacji o punktach końcowych, schematach żądań/odpowiedzi i uwierzytelnianiu. ### API BMS/SCADA stron trzecich Niektóre platformy BMS i SCADA udostępniają własne HTTP API lub API dostawcy — na przykład Siemens Building X i Web Port. Gdy jest ono używane, myCoreAI integruje się przez to API, aby wykrywać punkty, odczytywać wartości bieżące i historyczne oraz zapisywać wartości zadane. Ten interfejs API — punkty końcowe, schematy, formaty parametrów — należy do dostawcy, a **dokumentacja dostawcy jest nadrzędnym źródłem odniesienia**. Zakres integracji, dane uwierzytelniające i włączenie są ustalane z Myrspoven podczas onboardingu. ### Myrspoven edge (lokalnie) Gdy połączenie za pośrednictwem łącznika lub dostępnego API dostawcy nie jest możliwe, Myrspoven edge działa w środowisku właściciela budynku, łączy się lokalnie z BMS i wymienia dane z chmurą Myrspoven. Edge komunikuje się wyłącznie wychodząco — pobiera potrzebne wartości zadane i zadania oraz odsyła z powrotem wartości i wyniki — więc po stronie budynku nie są wymagane żadne przychodzące otwarcia zapory sieciowej. ## Uwierzytelnianie i dane uwierzytelniające Myrspoven AI-API używa tokenów bearer OAuth2. Identyfikator klienta i sekret są wydawane przez Myrspoven i przekazywane bezpiecznym kanałem — nigdy przez e-mail ani czat. Dokumentacja OpenAPI opisuje przepływ tokenów. Gdy zewnętrzne API dostawcy wymaga uwierzytelniania (zwykle konta serwisowego do dostępu zapisu), dane uwierzytelniające są tworzone po stronie dostawcy i przekazywane Myrspoven bezpiecznym kanałem. Niektóre platformy dostawców umożliwiają dostęp tylko do odczytu bez uwierzytelniania; jest to ustawienie dostawcy. Zapis zawsze wymaga dedykowanego konta serwisowego. Wymagane zakresy i uprawnienia są określane przez Myrspoven dla każdej integracji podczas onboardingu. ## Środowiska Integracje są konfigurowane dla każdego budynku w odniesieniu do jednego środowiska produkcyjnego. Zmiany, które mogłyby wpłynąć na działający budynek, są koordynowane z Myrspoven, a bezpiecznym sposobem testowania jest wstrzymanie zapisów dla testowanego budynku. ## Obsługa błędów W przypadku pierwszoplanowego Myrspoven AI-API kody odpowiedzi i schematy błędów są opisane w dokumentacji OpenAPI. Dla zewnętrznych interfejsów obsługa błędów odbywa się zgodnie z konwencjami dostawcy, który jest właścicielem danego interfejsu. Gdy myCoreAI nie może połączyć się z BMS, przestaje zapisywać wartości zadane, a BMS nadal działa według własnej logiki — budynek działa normalnie; wstrzymana zostaje jedynie optymalizacja do czasu przywrócenia połączenia. ## Limity szybkości Częstotliwość odczytu i zapisu jest ustalana dla każdego budynku podczas uruchamiania. Ten sam harmonogram obowiązuje, gdy budynek łączy się przez Myrspoven edge; edge pobiera z chmury Myrspoven zadania do wykonania i nie utrzymuje własnych interwałów. Odczyty są domyślnie wykonywane co 15 minut w większości integracji oraz co 12 minut dla Web Port. Zapisy wartości zadanych są wykonywane co 15 minut, z wykorzystaniem najnowszego wyniku optymalizacji. Gdy zewnętrzny dostawca narzuca własne limity szybkości, są one opisane w jego dokumentacji i dostosowywane w koordynacji z Myrspoven. ## Uzyskiwanie pomocy W sprawach integracji wykraczających poza interfejsy opisane tutaj skontaktuj się bezpośrednio z 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.myrspoven.com/myrspoven-docs/myrspoven-docs-pl/dokumentacja-dla-deweloperow/myrspoven-ai-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.