> 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-programistow/myrspoven-ai-api.md). # Myrspoven AI-API myCoreAI wymienia dane i wartości zadane z każdym budynkiem za pośrednictwem jednej z kilku powierzchni — natywnego Myrspoven AI-API, interfejsu API BMS/SCADA strony trzeciej lub Myrspoven edge działającego lokalnie (on-premise). Ta strona opisuje każdą z tych powierzchni i odsyła do dokumentacji dostawcy tam, gdzie interfejs API należy do strony trzeciej. Dla koncepcyjnego modelu przepływu danych zobacz [Pierwsze kroki z integracją systemu](/myrspoven-docs/myrspoven-docs-pl/integracje/overview.md). ## Dostępne interfejsy API ### Myrspoven AI-API (własne) Chmura Myrspoven udostępnia własny HTTP API do wymiany danych budynkowych z myCoreAI — odczytu bieżących wartości i wartości zadanych, wykrywania sygnałów, zapisu wartości zadanych oraz przesyłania danych sygnałowych. Po stronie budynku integruje się łącznik, 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 przesyłania wartości budynkowych z powrotem. API jest opisane w **dokumencie referencyjnym OpenAPI** w tej sekcji, który stanowi wiążące źródło informacji o punktach końcowych, schematach żądań/odpowiedzi i uwierzytelnianiu. ### Interfejsy API BMS/SCADA stron trzecich Niektóre platformy BMS i SCADA udostępniają własny HTTP lub interfejs API dostawcy — na przykład Siemens Desigo i Web Port. Gdy jest on używany, myCoreAI integruje się przez to API, aby wykrywać punkty, odczytywać wartości bieżące i historyczne oraz zapisywać wartości zadane. Powierzchnia API — punkty końcowe, schematy, formaty parametrów — należy do dostawcy i **dokumentacja dostawcy jest miarodajnym źródłem odniesienia**. Zakres integracji, poświadczenia i włączenie są ustalane z Myrspoven podczas wdrażania. ### Myrspoven edge (lokalnie) Gdy połączenie za pośrednictwem łącznika lub dostępnego interfejsu 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 wartości i wyniki — więc po stronie budynku nie są wymagane żadne przychodzące otwarcia zapory. ## Uwierzytelnianie i poświadczenia Myrspoven AI-API używa tokenów typu 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. Jeśli interfejs API dostawcy zewnętrznego wymaga uwierzytelniania (zwykle konta serwisowego do uprawnień zapisu), poświadczenia są tworzone po stronie dostawcy i przekazywane Myrspoven bezpiecznym kanałem. Punkty końcowe tylko do odczytu na niektórych platformach działają bez uwierzytelniania. Zapisy zawsze wymagają dedykowanego konta serwisowego. Wymagane zakresy i uprawnienia są określane przez Myrspoven dla każdej integracji podczas wdrażania. ## Ś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 Dla własnego Myrspoven AI-API kody odpowiedzi i schematy błędów są opisane w dokumentacji OpenAPI. W przypadku powierzchni stron trzecich obsługa błędów przebiega zgodnie z konwencjami dostawcy, który jest właścicielem tej powierzchni. 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 funkcjonuje normalnie; jedynie optymalizacja zostaje wstrzymana do czasu przywrócenia połączenia. ## Limity przepustowości Częstotliwość odczytów i zapisów jest uzgadniana dla każdego budynku podczas uruchamiania. Odczyty zwykle odbywają się co jedną do pięciu minut; zapisy wartości zadanych wykonywane są w stałym rytmie — zazwyczaj co 15 minut — z wykorzystaniem najnowszego wyniku optymalizacji. Jeśli dostawca zewnętrzny nakłada własne limity przepustowości, są one opisane w jego dokumentacji i dostrajane w koordynacji z Myrspoven. ## Uzyskiwanie pomocy W sprawach integracyjnych wykraczających poza opisane tutaj powierzchnie 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 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-pl/dokumentacja-dla-programistow/myrspoven-ai-api.md?ask=&goal= ``` `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.