Mer information för den som genomför IN-integrationen
SDL genomgår för närvarande en arkitekturreform, som kommer att omfatta lanseringen av gränssnittsversion 12 och, efter en övergångsperiod, en utfasning av gränssnittsversion 11. Vänligen ta hänsyn till denna förändring när du planerar din nya integration!
Gränssnitts- och arkitekturreformÖppnas i ett nytt fönster.
Ansökan om användningstillstånd
För att ta i bruk IN-gränssnittet krävs en ansökan om användningstillstånd.
Hur tar jag i bruk IN-gränssnittet
Anvisningar för genomförandet av integrationen
När Myndigheten för digitalisering och befolkningsdata har godkänt ansökan om användningstillstånd kan din organisation börja genomföra integrationen med hjälp av SDL:s kundtestmiljö. Information om kundtestmiljön finns i slutet av denna sida.
- IN-gränssnittets metoder i SwaggerÖppnas i ett nytt fönster.
- IN-gränssnittets metoder, gränssnittsversion 11 Myndigheten av digitalisering och befolkningsdata (Excel) (XLSX, 222,06 kB)Öppnas i ett nytt fönster.
Integrationen ska genomföras så att ändringar som ska göras i källsystemet minst en gång i dygnet förs in i SDL. Även uppgifter som tas bort från källsystemet ska raderas från SDL minst en gång per dygn.
Identifiering i gränssnittet
Användaren behöver en giltig API-nyckel och en giltig token för att kunna använda metoder i IN-gränssnittet eller metoder i OUT-gränssnittet vars användningsrätt har begränsats.
IN-integrationen är alltid organisationsspecifik. Det organisationsspecifika användarnamnet och lösenordet skickas till Suomi.fi-serviceadministrationens server för behörighetshantering, som returnerar den token som behövs för identifieringen.
Autentisering till produktionsmiljön med hjälp av token
Tokenen i produktionsmiljön innehåller uppgifter om användarrättigheter, roller samt giltighetstid för tokenen.
Token-länk: https://palveluhallinta.suomi.fi/api/auth/api-loginÖppnas i ett nytt fönster.
Giltigheten för token är begränsad. Giltighetstiden anges i informationen på insidan av token.
Parametrar för token
Headers:
• Content-Type:application/json
Body:
• username: user
• password: pwd
• apiUserOrganisation: organisationens ID (valfri)
Anropet returnerar parametern serviceToken.
Om API-nyckeln är kopplad till flera organisationer ska användaren ange Serviceadministrationens organisations-ID i anropet via parametern apiUserOrganisation. Om parametern utelämnas returnerar tokenen det organisations-ID som i Serviceadministrationen är markerat som den aktiva organisationen.
Anropsexempel 1 – API-organisations-ID har inte angivits
"username":"username@domain.fi",
"password":"validpassword"
}
Anropsexempel 2 – API-organisations-ID har angivits
{
"username":"username@domain.fi",
"password":"validpassword",
"apiUserOrganisation": "9cb2abc6-5458-4811-bbdd-83f75ceeed25"
}
Response
{
"serviceToken":"eyJhlsdlksd...."
}
Observera att det är skillnader i tillståndsgivningens gränssnitt (token) i servicedatalagrets produktionsmiljö och kundtestmiljö. Produktionsmiljön har fältet apiUserOrganisation, som inte finns i kundtestmiljön.
Om API-användarnamnet har kopplats till fler än en organisation kan begäran om tillstånd riktas till den önskade organisationen via fältet apiUserOrganisation. I fältet anges det id som Suomi.fi-serviceadministrationen returnerat.
I kundtestmiljön kan en token endast kopplas till en organisation, vilket innebär att tokenen inte kan användas för att testa integrationer där flera organisationer ingår.
Testning av den tekniska beredskapen
När integrationen har genomförts i kundtestmiljön ska din organisation testa hur gränssnittsförbindelsen fungerar (brandväggsöppningar, användarrättigheter osv.) i kundtestmiljön. Gränssnittsförbindelsen testas med material som inte tidigare förts in i kundtestmiljön (t.ex. med gränssnittet). Vid testningen av den tekniska beredskapen testas
- hur man lägger till och redigerar nya underorganisationer, nya tjänster och nya servicekanaler
- att lägga till och redigera kopplingar och tilläggsuppgifter om kopplingar
- att datafälten är korrekta (dataformat, längder, obligatoriskheter osv.).
- arkivering av uppgifter som avlägsnats från källsystemet
Din organisation ska utarbeta en testrapport och skicka den till ptv-tuki@dvv.fi.
Testning av innehållet
För att IN-integrationen ska kunna testas och tas i bruk måste även innehållet vara uppdaterat och uppfylla SDL:s kvalitetskrav. Vi förutsätter en testrapport av vilken datakvaliteten och överensstämmelsen med datamodellen framgår. SDL-kundorganisationens SDL-huvudanvändare ansvarar för kvalitetstestningen av innehållet.
Läs mer om testning av innehållet
Gör eventuella korrigeringar och produktionsinstallation
MDB bedömer utifrån testrapporterna om din organisation kan beviljas produktionsbehörigheter för IN-gränssnittet. Detta kan kräva flera iterationsrundor.
När testrapporterna har godkänts skickar MDB enligt separat överenskommelse API-användarrättigheter till SDL:s produktionsmiljö till kundorganisationen eller programleverantören till den adress som specificerats i ansökan om användningstillstånd. Därefter kan ni genomföra produktionsinstallationen.