Mer information för den som genomför importintegrationen (gränssnittsversion 12)

Denna sida är preliminär och kompletteras under hösten 2026.

Innan du börjar genomföra importintegrationen ska du bekanta dig med anvisningen Teknisk dokumentation för den som genomför integrationen (gränssnittsversion 12).

Ansökan om användningstillstånd

För att använda importgränssnittet krävs ett separat användningstillstånd. Gör en ansökan om användningstillstånd innan du tar i bruk importintegrationen.

Hur tar jag i bruk importgränssnittet

Anvisningar för genomförandet av integrationen

När du har ansökt om användningstillstånd kan du börja genomföra importintegrationen i kundtestmiljön. Uppgifterna om kundtestmiljön finns i slutet av denna sida.

Se till att integrationen överför ändringarna i källsystemet till SDL minst en gång per dygn. Ta bort uppgifter från SDL som har tagits bort från källsystemet. Ta bort uppgifter minst en gång per dygn. 

Bekanta dig med gränssnittens metoder och datastrukturer i Scalar-dokumentationen:

• Gränssnittsdokumentation för kundtestmiljön i ScalarÖppnas i ett nytt fönster.
• Gränssnittsdokumentation för produktionsmiljön i ScalarÖppnas i ett nytt fönster.

Identifiering i importgränssnittet

För att använda metoderna i importgränssnittet och metoderna i sökgränssnittet med begränsade användarrättigheter behöver du

• en giltig token
• en giltig API-nyckel. Se bruksanvisningen för API-nyckeln.

Med en token identifierar man användarens användarrättigheter. Med en API-nyckel identifierar man vilken integration gränssnittsanropet görs ifrån.

Genomförandet av importintegrationen är alltid organisationsspecifikt. Skicka organisationsspecifikt API-användarnamn och lösenord till Suomi.fi-serviceadministrationens server för behörighetshantering. Servern returnerar den token som behövs för identifieringen.

Inloggning i produktionsmiljön med hjälp av token

Token för produktionsmiljön innehåller uppgifter om användarrättigheter och tokens giltighetstid. Kontrollera giltighetstiden i tokens uppgifter och hämta en ny token innan den nuvarande går ut.

Adress för hämtning av token: (kompletteras senare)

Hämta token

Skicka token-begäran med följande uppgifter.

Header 
Content-Type:application/json 

Body 
username: user 
password: pwd 
apiUserOrganisation: organisation ID (valfri) 

Anropet returnerar parametern serviceToken.

Om API-användarnamnet har kopplats till flera organisationer

• Rikta token-begäran till önskad organisation genom att använda fältet apiUserOrganisation.
• Ange organisationens kod (ID) som Suomi.fi-serviceadministrationen returnerat som värde i fältet.
• Om du inte använder apiUserOrganisation skapas token för den organisation som har antecknats som aktiv i Suomi.fi-serviceadministrationen.

Anropsexempel 1, organisationens ID anges inte

{ 
  "username":"username@domain.fi", 
  "password":"validpassword" 
} 

Anropsexempel 2, organisationens ID anges

{ 
  "username":"username@domain.fi", 
  "password":"validpassword", 
  "apiUserOrganisation": "9cb2abc6-5458-4811-bbdd-83f75ceeed25" 
} 

Exempelsvar

{ 
  "serviceToken":"eyJhlsdlksd...." 
} 

Notering om produktions- och kundtestmiljön

Token i produktionsmiljön och kundtestmiljön skiljer sig strukturellt från varandra.
När du hämtar en token i produktionsmiljön ska du använda fältet apiUserOrganisation i begäran om du vill rikta token till en viss organisation.

Testa integrationen innan du övergår till produktion

Testa importintegrationen i kundtestmiljön innan du börjar använda den i produktionsmiljön.

Bekanta dig först med testningsanvisningen: 

Testning av importintegrationen i kundtestmiljön (inkluderar testrapportmallar)  (på finska)

Testa att: 

• integrationen fungerar på det tekniskt planerade sättet
• uppgifterna som överförs motsvarar SDL:s krav 
• gränssnittsförbindelserna och användarrättigheterna fungerar korrekt. 

Gör upp de rapporter som krävs om testningen och skicka dem till MDB på det sätt som beskrivs i testanvisningen. 

Reparationer och produktionsinstallation

När du har utfört de nödvändiga testningarna och skickat in testrapporterna till MDB ska du gå vidare till produktion enligt testanvisningen.

Gå till produktion

1. Skicka testrapporterna till MDB.
2. Vänta tills testningen har godkänts.
3. Ta emot uppgifterna om API-användarnamnet för produktionsmiljön.
4. Gör en produktionsinstallation.

När testningen har godkänts skickar MDB API-användarnamnet för SDL:s produktionsmiljö och tillhörande lösenord till den e-postadress som angetts i ansökan om användningstillstånd.

Exempel på de vanligaste användningsfallen

https://api.palvelutietovaranto.trn.suomi.fi/api/auth/oauth/connect/token

Header 
Content-Type: application/json 

Body 
username: user 
password: pwd 
apiUserOrganisation: organisation ID (valfri)

{ 
  "username":"username@domain.fi", 
  "password":"validpassword" 
} 

{ 
  "ptvToken":"eyJhlsdlksd...." 
}