Onboarding-flow for ekstern signal
Tip
Onboarding-retningslinjen er beregnet til nye integrationer, der bruger Eniris MQTT-protokollen.
En ulempe ved MQTT-protokollen er, at der ikke er nogen notifikation eller dataoverførsel, når en ny installation tilføjes. Derfor anbefales det at inkludere følgende trin, før der foretages fuld integration med Sofar EMS.
Opsætning
Følgende er nødvendigt for at opsætte et onboarding-flow
-
Ekstern API
- Der kræves et offentligt API
-
Mindst to endpoints
- Onboarding-endpoint Onboarding-endpointet kan bruges af Sofar EMS til at sende et signal, der angiver, at installationen er klar til at blive styret. Yderligere oplysninger kan inkludere kontraktnumre indtastet af brugere, installationsadresse, enhedsinfo
- Offboarding-endpoint Offboarding-endpointet kan bruges til at angive, at det eksterne styresignal er fjernet fra Sofar EMS, og styring ikke længere er mulig.
- Status-/helbredstjek-endpoint Helbredstjek-endpointet kan regelmæssigt poll'es af Sofar EMS for at give en statusopdatering af enhederne eller systemet som helhed.
Eksempel
-
En ny bruger tilføjer det eksterne signal i Sofar EMS. Onboarding-endpointet vil blive kaldt for at angive, at Sofar EMS er klar til at modtage kommandoer.
-
Sofar EMS har mistet forbindelse til batteriet. Helbredstjek-endpointet vil indeholde en fejlbesked.
-
Et kontraktnummer er nødvendigt for at knytte et Sofar EMS serienummer til en kunde. Et kontraktnummer kan inkluderes i onboarding-flowet, hvilket reducerer frem og tilbage kommunikation mellem eksterne signaler og slutkunder.
