Val av anslutningssätt och gränssnitt
I den här artikeln presenteras två tekniska anslutningssätt för Suomi.fi-fullmakter och anvisningar för hur man väljer ett lämpligt anslutningssätt. Anslutningssätten är Web API-anslutning och anslutningsserver- eller Informationsled-anslutning.
För ärendehantering på en persons vägnar används i allmänhet alltid Web API-anslutning. För uträttande av ärenden för ett företags räkning kan man däremot använda antingen Web API- eller Informationsledens anslutning.
Web API-anslutningen lämpar sig både för att uträtta ärenden för en person och för ett företag. Med hjälp av den är det enkelt och snabbt att genomföra fullmaktsförfrågningar. Den snabbaste drifttagningen har genomförts inom fyra dagar från planering till produktion.
Web API-gränssnittet erbjuder ett valgränssnitt för att välja att uträtta ärenden för någon annan samt REST-förfrågningsgränssnitt för förfrågningar om ärenderättigheter. Vid anrop till gränssnitt utnyttjas REST-/JSON-gränssnitt som är skyddade med antingen API Key- eller OAuth2 + API Key-skydd. Bekanta dig närmare med Web API-gränssnittsbeskrivningen.
I Web API-anslutningen väljs huvudmannen alltid med valgränssnittet för tjänsten Fullmakter, dit användarens session styrs från e-tjänsten. Efter valet återvänder användarens session till e-tjänsten.
Med Web API-anslutningen görs fullmaktskontrollförfrågningarna i tjänsten Fullmakter via offentligt internet, varvid det inte finns något behov av en separat anslutningsserver. Vid anrop till gränssnitt utnyttjas REST-/JSON-gränssnitt.
Web API-anslutningen används för att uträtta ärenden för en persons räkning bl.a. i MinSkatt och Mina Kanta.
Användningen av Informationsleden i tjänsten Fullmakter lämpar sig främst för att uträtta ärenden för ett företags räkning.
Det är skäl att reservera betydligt mer tid för drifttagningen av Informationsleden än för Web API-anslutningen. Vanligtvis tar processen flera månader.
Det gränssnitt som används erbjuds via Informationsleden (X-Road 6). Utnyttjandet av Informationsleden i tjänsten Fullmakter förutsätter alltså också ibruktagande av Informationsleden, installation och underhåll av anslutningsservern samt brandväggsöppningar. Bekanta dig med Informationsledens ibruktagning.
Fullmaktsförfrågningarna rör sig som SOAP-meddelanden mellan systemen. Förfrågningar kan göras utan att användaren lägger märke till det.
Användningen av Informationsleden i tjänsten Fullmakter gör det möjligt att välja huvudman via e-tjänstens eget användargränssnitt.
Bekanta dig närmare med följande gränssnittsbeskrivningar:
- gränssnittsbeskrivning av fullmaktskontrollförfrågan vid uträttande av ärenden för ett företags räkning.
Användningen av Informationsledens anslutning i tjänsten Fullmakter förutsätter ibruktagandet av Informationsleden, anslutningsservern och brandväggsöppningar. Informationsledens interna trafik är trafik mellan anslutningsservrarna som sker via offentligt internet. I anslutningsservrarnas gränssnittsgenomförande används ett SOAP-datakommunikationsprotokoll som baserar sig på XML-språket.
Informationsleden utnyttjas som anslutningssätt för att uträttande av ärenden för ett företags räkning bl.a. i MinSkatt.
Om man i e-tjänsten vill göra det möjligt att uträtta ärenden för en persons räkning, rekommenderas Web API-anslutning.
Om man i e-tjänsten vill göra det möjligt att uträtta ärenden både för en persons räkning och ett företags räkning, rekommenderas Web API-anslutning. I annat fall måste integrationen genomföras med två olika anslutningssätt.
Om man i e-tjänsten endast vill göra det möjligt att uträtta ärenden för ett företags räkning och man vill välja huvudman med e-tjänstens eget användargränssnitt, är Informationsledens anslutning det enda alternativet.
Nedan beskrivs slutanvändarens ärendehanteringsväg när hen uträttar ärenden för någon annan i e-tjänsten. I det första exemplet visas hur ärendet framskrider med Web API-anslutningen. I det andra exemplet beskrivs hur man uträttar ärenden med Informationsledens anslutning.
Serviceväg vid användning av Web API-anslutning
- Slutanvändaren identifierar sig i e-tjänsten.
- Slutanvändaren väljer "Uträttande av ärenden för någon annan".
- Sessionen överförs till valgränssnittet för tjänsten Fullmakter. Där väljer användaren för vem hen vill uträtta ärenden.
- Efter valet återvänder sessionen till e-tjänsten. Användaren fortsätter uträtta ärenden för den valda huvudmannens (person eller företag) räkning.
Serviceväg vid användning av Informationsledens anslutning
- Användaren identifierar sig i e-tjänsten.
- Användaren väljer via ärendetjänstens användargränssnitt det företag för vars räkning hen vill uträtta ärenden.
- Efter valet fortsätter användaren uträtta ärenden för det valda företagets räkning.
Web API-anslutning
Gör först en ansökan om användningstillstånd.Öppnas i ett nytt fönster.
Meddela returadressen för Web API-anslutningen till ibruktagningsteamet för tjänsten Fullmakter. Det är adressen till din organisations e-tjänst, dit slutanvändarens webbläsarsession styrs när hen har valt huvudman med valgränssnittet för tjänsten Fullmakter.
I testningsskedet kan Web API-anslutningens returadress vara localhost. Protokollet ska vara HTTPS om adressen visar något annat än localhost-adressen.
När e-tjänsten inleder en OAuth-fullmaktsprocess förmedlar den en ny omdirigeringsadress till tjänsten Fullmakter, dit användarens webbläsare styrs efter valet av huvudman. För att OAuth-nyckeln som förmedlas tillsammans med returbegäran inte ska hamna i fel händer begränsar tjänsten Fullmakter omdirigeringen endast till de adresser som fastställts för den på förhand. E-tjänsten ska i samband med anslutningsprocessen lämna uppgifter om exakta adresser för omdirigering till tjänsten Fullmakter.
Informationsledens anslutning
Ta Informationsleden i bruk.Öppnas i ett nytt fönster.
När din organisation har tagit i bruk Informationsleden ska du meddela nödvändiga uppgifter om ditt subsystem till ibruktagningsteamet för tjänsten Fullmakter:
- Member Class
- Member Code
- Subsystem Code