Ta i bruk en tjänst som tillhandahålls via Suomi.fi-informationsleden

I den här anvisningen redogör vi för hur man börjar använda en tjänst som ingår i Suomi.fi-informationsleden och som presenteras i API-katalogen. Avtala alltid separat med tjänsteleverantören om ibruktagandet av tjänsterna.

Förutsättningar:

Din organisation måste vara ansluten till Informationsleden och den måste ha ett fungerande subsystem innan ansökning om användningstillstånd till en enskild tjänst. Se till att din anslutningsserver har minst ett subsystem. Anvisningar om att lägga till ett nytt subsystem till anslutningsservern finns i en separat stödartikel. Du kan också kolla att subsystemet finns i API-katalogenÖppnas i ett nytt fönster. i din egen organisations uppgifterna.

API-katalogenÖppnas i ett nytt fönster. presenterar subsystem som kopplats till Informationsleden. I stödartikeln Sök tjänster i API-katalogen kan du läsa om hur man hittar tjänster i API-katalogen.

Gör så här om du vill börja använda en tjänst som du har hittat i API-katalogen:

1. Anslut din organisation till Suomi.fi-informationsleden
2. Bekanta dig med tjänstens användarvillkor och tekniska uppgifter
3. Ansök om användningstillstånd till tjänsten
4. Koppla din organisations och tjänsteleverantörens datasystem till varandra.

1. Anslut din organisation till Suomi.fi-informationsleden

Om din organisation har för avsikt att utnyttja de tjänster som tillhandahålls via Informationsleden, måste den vara med i Informationsledens produktionsmiljö. Heltäckande anvisningar för hur man ansluter sig till Informationsleden finns på sidorna som handlar om ibruktagandet av Informationsleden. Det är bra att reservera cirka 1-3 månader för anslutningsprocessen.

Anslutningsprocessen omfattar följande:

1. Planering av anslutningsprocessen och upprätthållandet av tjänsterna
2. Ibruktagande av anslutningsserverlösningen samt ansökan om användningstillstånd
3. Anslutning till testmiljön
4. Testning av funktionaliteten i testmiljön
5. Övergång till produktionsmiljö

Vi rekommenderar att ni redan i samband med anslutningen till testmiljön testar att era subsystem är kompatibla med tjänsteleverantören. 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 nedan.

2. Bekanta dig med tjänstens användarvillkor och tekniska uppgifter i API-katalogen

Den organisationen som tillhandahåller tjänsten informerar om sin tjänst i sin beskrivning av subsystemet. Se till exempel Myndigheten för digitalisering och befolkningsdatas beskrivning av VTJ-gränssnittetÖppnas i ett nytt fönster..

Om subsystemets beskrivning saknas uppgifter som du behöver, be tjänsteleverantören om uppgifter som saknas.

Säkerställ att ibruktagande är möjligt

Kontrollera först med tjänsteleverantören att det är möjligt för din organisation att ta i bruk tjänsten

• med hänsyn till användningsvillkoren och
• ur teknisk synvinkel.

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 (anslutningarna) som finns i API-katalogen.

Tekniska uppgifter

Närmare uppgifter om tjänstens gränssnitt finns i subsystemets bilagor. Om tjänsten baserar på SOAP-protokollet visas tjänsteuppgifterna 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 ingen 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.

3. Ansök om användningstillstånd till tjänsten

Användningen av tjänster kan förutsätta att du ansöker om en användningstillstånd. Beroende på vilken tjänst som du ska ta i bruk, kan du ansöka användningstillstånd antingen i API-katalogen eller genom att kontakta tjänsteleverantören.

Ansök om användningstillstånd i API-katalogen

Du kan ansöka om användningstillstånd till subsystemet och tjänster i API-katalogen, om tjänsteleverantören har tagit funktionen i bruk. Du kan också ansöka om användningstillstånd för en annan organisationen. När tjänsteleveräntören har tagit funktionen i bruk, ser inloggade användare en separat del Be om tillstånd att använda detta subsystem. Mer information om att ansöka om användningstillstånd hittar du i en separat stödartikel.

Kontakta tjänsteleverantören

När du hittar en tjänst i API-katalogen som du vill ta i bruk ska du kontakta den organisationen som tillhandahåller tjänsten.

Tjänsteleverantörens kontaktuppgifter finns i API-katalogen bland uppgifterna om subsystemet. Om du inte hittar kontaktuppgifterna kan du be om hjälp av oss som underhåller API-katalogen: palveluvayla@palveluvayla.fiÖppnas i ett nytt fönster..

4. Koppla din organisations och tjänsteleverantörens datasystem till varandra

Din organisations datasystem ansluts till Informationsleden via en anslutningsserver och ett subsystem

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 informationssystem redan vara anslutet till Informationsleden.

Din organisations informationssystem, 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 gränssnitt mellan anslutningsservern och informationssystemet. Uppgifterna hämtas således till ditt informationssystem från ett annat datasystem i Informationsleden som trafik mellan två organisationers subsystem.

I praktiken tas anslutningsservern i bruk och läggs subsystemet i samband med att organisationen ansluter sig till Informationsleden.

Läs anvisningarna om hur man tar i bruk anslutningsservern och lägger till ett subsystem:

• Tekniska krav på anslutningsservern
• Installationsanvisningar för anslutningsserverns program på RHEL-anslutningsservrar
• Installationsanvisningar för anslutningsserverns program på Ubuntu-anslutningsservrar
• Anslutning av anslutningsservern till test- eller produktionsmiljön
• Lägg till ett nytt subsystem till anslutningsservern och ta bort det

Testa först att det går att sammanföra datasystemen i testmiljö

Innan ni förenar era datasystem i Informationsledens produktionsmiljö ska ni utföra tester i testmiljö. 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:

• Miljöer av Informationsleden och API-katalogen
• Informationsledens provtjänster

Att tänka på vid sammanförandet av datasystem

När ni börjar sammanföra era datasystem behöver tjänsteleverantören åtminstone följande:

• uppgifter som ditt subsystem som behövs för tillstånd (subsystemets namn = X-Road subsystem code)
• din anslutningsservers IP-adress för nödvändiga portöppningar (5500 och 5577).

Din organisation behöver information om anslutningsserverns IP-adress för att kunna öppna samma portar.

Kontrollera också att förbindelsernas status lyser grönt (fungerar) i Diagnostics-menyn i anslutningsserverns administrationsgränssnitt:

• Global Conf
• TSA timestamping
• OCSP (G3).