Før denne konfigurasjonen er satt opp, må den grunnleggende installasjonen av Handyman API være på plass. Denne siden kan finnes her: Oppsett av Handyman API
Handyman API er en tjeneste som gir eksterne programmer og/eller tjenester tilgang til Handyman's data.
Noen eksempler kan være:
- Integrasjoner med ERP-systemer
- Ekstraksjon av data for behandling i eksterne systemer
- Handyman Office rapporter på mobile enheter
- Oppsett og konfigurasjon av Handyman Portalen
For at Handyman API skal være tilgjengelig på internett, må det settes opp med sikker kommunikasjon mellom partene. I praksis betyr dette at API-tjenesten må kjøre på https (TCP 443) og ikke http (TCP 80), noe som ville vært godt nok hvis bare lokale tjenester skulle ha tilgang til Handyman API.
Å kjøre en tjeneste på https innebærer også at det må settes opp et sertifikat lokalt på serveren der tjenesten skal kjøre. Dette er ikke noe GSGroup AS tilbyr, men kunden må selv installere et sertifikat som vi kan knytte til vår tjeneste.
Nedenfor er listen over punkter som må settes opp og konfigureres
-
Installasjon av sertifikat på server
IT-ansvarlig eller leverandøren av miljøet må skaffe et sertifikat som kan brukes til https-trafikk. Dette må installeres i henhold til standard prosedyrer. -
Åpning av trafikk fra internett til serveren
Her må kundens IT-sjef eller leverandør utføre to forberedende oppgaver:
a. Koble et navn i domenet som peker til en ekstern IP-adresse som kunden disponerer. Et eksempel kan være: hmapi.kunde.com, men dette er helt valgfritt.
b. Åpne for trafikk https (TCP 443) fra internett og rutetrafikken til serveren der Handyman API-tjenesten skal kjøre. -
Lenke sertifikat til Handyman API
Dette gjøres ved å finne tommelfingeravtrykket til sertifikatet på serveren via MMC (Microsoft Management Console) og koble dette til GUID-en til Handyman API.
a. Start MMC fra "Kjør"
b. Legg til visning for sertifikater
c. Finn sertifikatet som er installert og kopier tommelfingeravtrykket
d. Tommelfingeravtrykk kan inneholde ugyldige tegn når de kopieres. Lim det inn i en tekstredigerer og fjern alle tegn slik at det kun er tall og bokstaver igjen.
e. Kjør følgende i ledetekst (må kjøres som administrator). X-ene må erstattes med tommelfingeravtrykket som ble kopiert ut tidligere.
"netsh http add sslcert ipport=0.0.0.0:443 appid={C504379D-4D9A-436B-82B0-858FE26AB997} certhash=XXXXXXXXXXXXXXXXXXXXXXXX" -
Konfigurasjon av Handyman Control Center
For at Handyman API skal kunne svare på https, må følgende konfigurasjon endres (eksempel i bildet nedenfor):
a. URL til Handyman API: Dette må inneholde "https://" og den lokale IP-adressen
b. Valgfri ekstern adresse: Den eksterne URL-en må bli skrevet inn her
c. URL til GSG Identity Management Server: Lenk kun til GSGroup's IDM (https://idm.gsgroup.io) -
Start tjenesten på nytt og test
Åpne en nettleser på en annen maskin som er tilkoblet internett med følgende adresse: https://hmapi.customer.com/swagger
Hvis du får opp nettsiden i nettleseren, er konfigurasjonen og oppsettet i orden.