Ibruktagning av en enskild tjänst
Den här artikeln beskriver hur ibruktagningen av en tjänst som erbjuds via Informationsleden går till när din organisation redan är ansluten till Informationsleden och har en fungerande anslutningsserver.
- Bekanta dig med tjänsten, dess användningsvillkor och tekniska information i API-katalogen
- Ansök om användningstillstånd för tjänsten (subsystemets användningstillstånd)
- Koppla samman din organisations och tjänsteleverantörens datasystem
Observera att ibruktagningen av en enskild tjänst alltid beror på tjänsteleverantören. Kontrollera tjänstespecifika instruktioner vid behov direkt från den organisation som tillhandahåller tjänsten.
Förhandskrav:
Innan du ansöker om användningstillstånd för en enskild tjänst måste din organisation vara ansluten till Informationsleden och ha ett fungerande subsystem. Kontrollera att minst ett subsystem har lagts till i din anslutningsserver.
- Du kan också kontrollera att subsystemet finns i API-katalogen Öppnas i ett nytt fönster.under din organisations uppgifter.
Obs! Om subsystemet läggs till i en anslutningsserver som ännu inte är i bruk inom Informationsleden, ska du följa instruktionerna för anslutning till testmiljön. Om din organisation planerar att använda tjänster via Informationsleden, måste den vara ansluten till produktionsmiljön. Anslutningen till Informationsleden beskrivs i sin helhet på sidan Ibruktagande.
1. Bekanta dig med tjänsten, dess användningsvillkor och tekniska information i API-katalogen
Den organisation som tillhandahåller tjänsten berättar om sin tjänst i sin beskrivning av subsystemet i API-katalogenÖppnas i ett nytt fönster..
- Se till exempel Myndigheten för digitalisering och befolkningsdatas beskrivning av BDSförfrågan-gränssnittetÖppnas i ett nytt fönster..
Om någon av de uppgifter du behöver saknas i beskrivningen av subsystemet, be tjänsteleverantören om de uppgifter som saknas.
Säkerställ att ibruktagningen är möjlig
Säkerställ att ibruktagningen av tjänsten är möjlig för din organisation
- för användarvillkorens del och
- teknikens del.
Användarvillkor
Ibruktagandet och användningen av tjänsterna kan vara förknippade med begränsningar, tillståndsansökningar och avgifter. De tjänstespecifika användarvillkoren finns i beskrivningarna av subsystemen som finns i API-katalogen.
Teknisk data
Närmare uppgifter om tjänstens gränssnitt finns i subsystemets bilagor. Om tjänsten baserar på SOAP-protokollet visas tjänstens uppgifter som en WSDL-fil. I tjänster som baserar sig på REST-modellen är filen oftast i JSON-format. Tjänsteleverantören har också kunnat lägga till andra tekniska dokument som bilagor till tjänsten, till exempel PDF-filer.
I API-katalogen presenteras tjänster som baserar dels på SOAP-protokollet (Simple Object Access Protocol), dels på REST-modellen (Representational State Transfer). Huruvida tjänsten är SOAP- eller REST-baserad inverkar på vilka tekniska lösningar som behövs för ibruktagandet av tjänsten. Till exempel behövs inte en så kallad adaptertjänst med REST-gränssnitten. REST är generellt sett en enklare lösning än SOAP, eftersom den inte är så strikt standardiserad.
2. Ansök om användningstillstånd för tjänsten (subsystemets användningstillstånd)
Användning av tjänster kan kräva att du ansöker om ett användningstillstånd för subsystemet. Beroende på vilken tjänst som ska tas i bruk, kan tillståndet sökas antingen via API-katalogen Öppnas i ett nytt fönster.eller genom att kontakta tjänsteleverantören.
Ansök om tillstånd i API-katalogen
I API-katalogen kan du ansöka om tillstånd att använda subsystemet och dess tjänster, om tjänsteleverantören har aktiverat funktionen. Du kan också ansöka om tillstånd som mellanhand för en annan organisations räkning. När funktionen är aktiverad visas en särskild sektion Begär tillstånd att använda detta subsystem på subsystemets sida för inloggade användare. Mer information om hur du ansöker om användningstillstånd i API-katalogen finns i instruktionerna.
Kontakta tjänsteleverantören
Om du hittar en tjänst i API-katalogen som du vill ta i bruk, men det inte är möjligt att ansöka om tillstånd via katalogen, kontakta tjänsteleverantören direkt.
Tjänsteleverantörens kontaktuppgifter finns i subsystemets information i API-katalogen. Om kontaktuppgifter saknas, kan du be om hjälp från API-katalogens administratörer:
palveluvayla@palveluvayla.fiÖppnas i ett nytt fönster.
Testning är möjlig när subsystemet har lagts till i anslutningsservern och användningstillståndet har beviljats. Vi rekommenderar att ni testar att era subsystem är kompatibla med tjänsteleverantören redan i samband med anslutningen till testmiljön. På så sätt säkerställer ni att meddelanden förmedlas problemfritt mellan din organisation och tjänsteleverantörens tjänst. Läs mer om testning i våra instruktioner.
3. Sammankoppla din organisations och tjänsteleverantörens datasystem
Din organisations datasystem kopplas till Informationsleden via anslutningsservern och subsystemet
Observera att när man börjar ansluta datasystemen som hör till den som utnyttjar tjänsten (du) med tjänsteleverantörens datasystem ska ditt kundsystem redan vara anslutet till Informationsleden.
Din organisations kundsystem, dvs. det datasystem dit du tänker importera uppgifter från Informationsledens övriga tjänster, ansluts till Informationsleden via anslutningsservern. Subsystemet fungerar däremot som ett gränssnitt mellan anslutningsservern och kundsystemet. Informationssökningen i ditt kundsystem från ett annat datasystem som anslutits till Informationsleden sker alltså mellan organisationernas subsystem.
Användarrättigheterna till informationsleden definieras på subsystemnivå, och därför bör man i princip använda subsystem som är specifika för respektive kundsystem. I vissa fall kan också flera kundsystem som bildar en logisk helhet utnyttja samma subsystem vid tjänsteanrop.
I praktiken tas anslutningsservern i bruk och läggs subsystemet till i samband med att organisationen ansluter sig till Informationsleden.
Testa först sammankopplingen av datasystemen i testmiljön
Innan ni ansluter ert datasystem i Informationsledens produktionsmiljö måste ni testa sammankopplingen i testmiljön. Kom överens om testningen med den organisation som tillhandahåller tjänsten.
Anteckna de fel som observerats under testningen och korrigera dem före övergången till produktionsmiljön. När allt fungerar utan problem i testmiljön kan ni börja sammanföra datasystemen i produktionsmiljön.
Läs anvisningarna om testmiljön och testningen:
• Informationsledens och API-katalogens miljöer
• Testtjänster i Informationsleden
Att beakta vid integration av datasystem
När ni påbörjar integrationen av era datasystem behöver tjänsteleverantören åtminstone följande information från dig:
- Identifieringsuppgifter för ditt subsystem för att bevilja användningstillstånd (subsystemets namn = X-Road subsystem code)
- IP-adressen till din anslutningsserver för att öppna nödvändiga portar (5500 och 5577)
Din organisation behöver också IP-adressen till tjänsteleverantörens anslutningsserver för att kunna öppna motsvarande portar.
Obs! Om det uppstår problem i kommunikationen mellan din organisation och tjänsteleverantören efter att användningstillståndet har beviljats och portarna har öppnats, kontrollera anslutningsserverns felloggar.
- NIIS:s supportartikel hjälper dig att tolka felmeddelanden:
How to Interpret Security Server Proxy Error Messages? – X-Road Knowledge Base – NIIS ConfluenceÖppnas i ett nytt fönster.