Før denne konfiguration kan sættes op, skal den grundlæggende installation af Handyman API være på plads. Denne side kan findes her: Opsætning af Handyman API
Handyman API er en service, der giver eksterne programmer og/eller tjenester adgang til Handyman's data.
Nogle eksempler kunne være:
- Integrationer med ERP-systemer
- Udtrækning af data til behandling i eksterne systemer
- Handyman Office rapporter på mobile enheder
- Opsætning og konfiguration af Handyman Portalen
For at Handyman API kan være tilgængelig på internettet, skal det konfigureres med sikker kommunikation mellem parterne. I praksis betyder dette, at API-tjenesten skal køre på https (TCP 443) og ikke http (TCP 80), hvilket ville være godt nok, hvis kun lokale tjenester skulle have adgang til Handyman API'en.
At køre en tjeneste på https indebærer også, at der skal opsættes et certifikat lokalt på serveren, hvor tjenesten skal køre. Dette er ikke noget, som GSGroup AS tilbyder, men kunden skal selv installere et certifikat, som vi kan linke til vores tjeneste.
Nedenfor er listen over punkter, der skal sættes op og konfigureres
-
Installation af certifikat på server
IT-chefen eller udbyderen af miljøet skal skaffe et certifikat, der kan bruges til https-trafik. Dette skal installeres efter standardprocedurer. -
Åbning af trafik fra internettet til serveren
Her skal kundens IT-chef eller leverandør udføre to forberedende opgaver:
a. Forbind et navn i domænet, der peger på en ekstern IP-adresse, som kunden råder over. Et eksempel kunne være: hmapi.customer.com, men dette er helt valgfrit.
b. Åbn for trafik https (TCP 443) fra internettet og rout trafikken til serveren, hvor Handyman API-tjenesten skal køre -
Tilføj certifikat til Handyman API
Dette gøres ved at finde tommelfingeraftrykket af certifikatet på serveren via MMC (Microsoft Management Console) og forbinde det til GUID'en for Handyman API.
a. Start MMC fra "Kør"
b. Tilføj visning for certifikater
c. Find det installerede certifikat og kopier tommelfingeraftrykket
d. Tommelfingeraftryk kan indeholde ugyldige tegn, når de kopieres. Indsæt det i en teksteditor og fjern eventuelle tegn, så kun tal og bogstaver er tilbage.
e. Kør følgende i en kommandoprompt (skal køres som administrator). X'erne skal erstattes med tommelfingeraftrykket, der blev kopieret tidligere.
"netsh http add sslcert ipport=0.0.0.0:443 appid={C504379D-4D9A-436B-82B0-858FE26AB997} certhash=XXXXXXXXXXXXXXXXXXXXXXXX" -
Konfiguration af Handyman Control Center
For at Handyman API kan svare på https, skal følgende konfiguration ændres (eksempel i billedet nedenfor):
a. URL til Handyman API: Dette skal indeholde "https://" og den lokale IP-adresse
b. Valgfri ekstern adresse: Den eksterne URL skal indtastes her
c. URL til GSG Identity Management Server: Link kun til GSGroups IDM (https://idm.gsgroup.io) -
Genstart tjenesten og testning
Start en browser på en anden maskine, der er tilsluttet internettet, med følgende adresse: https://hmapi.customer.com/swagger
Hvis du får websitet frem i en browser, er konfigurationen og opsætningen i orden.