Innan denna konfiguration är inställd måste den grundläggande installationen av Handyman API vara på plats. Den sidan kan hittas här: Inställning av Handyman API
Handyman API är en tjänst som ger externa program och/eller tjänster åtkomst till Handyman's data.
Några exempel kan vara:
- Integrationer med ERP-system
- Extrahering av data för bearbetning i externa system
- Handyman Office rapporter på mobila enheter
- Installation och konfiguration av Handyman Portal
För att Handyman API ska kunna göras tillgängligt på internet måste det konfigureras med säker kommunikation mellan parterna. I praktiken innebär detta att API-tjänsten måste köras på https (TCP 443) och inte http (TCP 80), vilket skulle vara tillräckligt bra om endast lokala tjänster skulle ha tillgång till Handyman API:n.
Att köra en tjänst på https innebär också att ett certifikat måste konfigureras lokalt på servern där tjänsten ska köras. Detta är inget som GSGroup AS erbjuder, men kunden måste installera ett certifikat själva som vi kan länka till vår tjänst.
Nedan finns listan över punkter som måste konfigureras och konfigureras
-
Installation av certifikat på servern
IT-chefen eller leverantören av miljön måste skaffa ett certifikat som kan användas för https-trafik. Detta måste installeras enligt standardförfaranden. -
Öppning av trafik från internet till servern
Här måste kundens IT-chef eller leverantör utföra två förberedande uppgifter:
a. Anslut ett namn i domänen som pekar på en extern IP-adress som kunden förfogar över. Ett exempel kan vara: hmapi.kund.com men detta är helt valfritt.
b. Öppna för trafik https (TCP 443) från internet och routa trafiken till servern där Handyman API-tjänsten ska köras. -
Länka certifikat till Handyman API
Detta görs genom att hitta tumavtrycket för certifikatet på servern via MMC (Microsoft Management Console) och koppla detta till GUID för Handyman API.
a. Starta MMC från "Kör"
b. Lägg till vy för certifikat
c. Hitta det installerade certifikatet och kopiera tumavtrycket
d. Tumavtryck kan innehålla ogiltiga tecken när de kopieras. Klistra in det i en textredigerare och ta bort alla tecken så att bara siffror och bokstäver återstår.
e. Kör följande i en kommandotolk (måste köras som administratör). X:en måste ersättas med tumavtrycket som kopierades tidigare.
"netsh http add sslcert ipport=0.0.0.0:443 appid={C504379D-4D9A-436B-82B0-858FE26AB997} certhash=XXXXXXXXXXXXXXXXXXXXXXXX" -
Konfiguration av Handyman Control Center
För att Handyman API ska kunna svara på https måste följande konfiguration ändras (exempel i bilden nedan):
a. URL till Handyman API: Detta måste innehålla "https://" och den lokala IP-adressen
b. Valfri extern adress: Den externa webbadressen måste fyllas i här
c. URL till GSG Identity Management Server: Länka endast till GSGroups IDM (https://idm.gsgroup.io) -
Starta om tjänsten och testa
Starta en webbläsare på en annan dator som är ansluten till internet med följande adress: https://hmapi.customer.com/swagger
Om webbplatsen visas i webbläsaren är konfigurationen och installationen i ordning.