Przegląd

Materiały referencyjne dla programistów i integratorów systemowych pracujących z myCoreAI programowo — łączących budynek, wymieniających dane z chmurą Myrspoven lub tworzących narzędzia na bazie istniejącej integracji.

stronę strona narracyjna która wyjaśnia, który interfejs integracyjny ma zastosowanie do budynku i jak działa, oraz dokumentacja OpenAPI która dokumentuje własny interfejs Myrspoven AI-API, endpoint po endpoincie.

Integratorzy: zaczynają od Pierwsze kroki z integracją systemową w rozdziale Integracje — wyjaśnia, jak edge, chmura Myrspoven i myCoreAI współdziałają, zanim jakiekolwiek szczegóły endpointów staną się przydatne.

Twórcy narzędzi: Myrspoven AI-API udostępnia wymianę danych i wartości zadanych przez HTTP. Dokumentacja OpenAPI jest źródłem nadrzędnym dla endpointów, schematów żądań/odpowiedzi i uwierzytelniania.

Spis treści

Myrspoven AI-API

Wyjaśnia interfejsy, przez które myCoreAI się integruje: własne HTTP API Myrspoven, komponent edge Myrspoven do łączności z lokalnym BMS oraz API dostawców BMS/SCADA firm trzecich. Obejmuje uwierzytelnianie, środowiska, obsługę błędów i limity szybkości.

dokumentacja OpenAPI

Maszynowo czytelna specyfikacja własnego Myrspoven AI-API — endpointy, parametry, schematy i uwierzytelnianie. To nadrzędne źródło szczegółów na poziomie endpointów; strona narracyjna zapewnia szerszy kontekst.

Poza zakresem

• Konfiguracja BMS i dostawców (Schneider, Siemens, Web Port itp.) znajduje się w Integracje rozdziale.
• Procedury operacyjne — dane uwierzytelniające VPN, utwardzanie serwera, procedury wdrożeniowe — nie są publiczne i są obsługiwane bezpośrednio z Myrspoven.
• Wewnętrzne narzędzia i potoki — własny proces kompilacji, testowania i wdrażania w Myrspoven — jest poza zakresem dokumentacji partnerskiej.

Konwencje

• Czasy są podawane w formacie ISO 8601 w UTC, o ile nie zaznaczono inaczej.
• "Chmura Myrspoven" odnosi się do hostowanego backendu; "edge" odnosi się do komponentu lokalnego; "myCoreAI" odnosi się do agenta AI działającego w chmurze.
• Poświadczenia w przykładach są zastępcze. Rzeczywiste poświadczenia są udostępniane bezpiecznym kanałem podczas integracji.
• W przypadku API stron trzecich dokumentacja dostawcy ma pierwszeństwo w szczegółach na poziomie endpointów, jeśli różni się od tych stron.

Uzyskiwanie pomocy

Zgłaszaj błędy lub braki do Myrspoven.