Przegląd

Materiał referencyjny dla deweloperów i integratorów systemów pracujących z myCoreAI programowo — łączących budynek, wymieniających dane z chmurą Myrspoven lub budujących narzędzia oparte na istniejącej integracji.

Sekcja ma dwie części: strona opisowa która wyjaśnia, który interfejs integracyjny dotyczy budynku i jak się zachowuje, oraz dokumentacji OpenAPI która dokumentuje autorskie endpointy Myrspoven AI-API, endpoint po endpoincie.

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

Deweloperzy narzędzi: Myrspoven AI-API udostępnia wymianę danych i wartości zadanych przez HTTP. Dokumentacja OpenAPI jest autorytatywnym źródłem informacji o endpointach, schematach żądań i odpowiedzi oraz uwierzytelnianiu.

Spis treści

Myrspoven AI-API

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

dokumentacji OpenAPI

Maszynowo czytelna specyfikacja autorskiego Myrspoven AI-API — endpointy, parametry, schematy i uwierzytelnianie. To autorytatywne źródło szczegółów na poziomie endpointów; strona opisowa zapewnia kontekst.

Poza zakresem

• Konfiguracja BMS i dostawców (Schneider, Siemens, Web Port itd.) znajduje się w Integracje rozdziale.

• Runbooki operacyjne — poświadczenia VPN, utwardzanie serwerów, procedury wdrożeniowe — nie są publiczne i są obsługiwane bezpośrednio z Myrspoven.

• Narzędzia wewnętrzne i potoki — własny proces budowania, testowania i wdrażania Myrspoven — jest poza zakresem dokumentacji dla partnerów.

Konwencje

• Czasy są podawane w formacie ISO 8601 w UTC, chyba że 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. Działające poświadczenia są udostępniane przez bezpieczny kanał podczas integracji.

• W przypadku interfejsów API firm trzecich, dokumentacja dostawcy ma pierwszeństwo w szczegółach na poziomie endpointów, gdy nie zgadza się z tymi stronami.

Uzyskiwanie pomocy

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