Bruksanvisning för API-nyckel (SDL-gränssnittsversion 12)
API-nyckeln i gränssnittsversion 12
- API-nyckeln tas i bruk från och med SDL:s gränssnittsversion 12 i både sökgränssnittet (OUT) och importgränssnittet (IN).
- API-nyckeln är miljöspecifik och ska beställas separat för varje integration som genomförs.
För att vi ska kunna informera er om sådant som påverkar er integration behöver Myndigheten för digitalisering och befolkningsdata uppgifter om den integration ni genomfört samt om kontaktpersonerna. Uppgifterna måste lämnas ut för att få API-nyckeln.
Beställning, hantering och användning av API-nyckel
Välj användarnamn för att beställa en API-nyckel
API-nyckeln skapas och hanteras i SDL:s administrationsgränssnitt för API-nyckeln.
- Det är bra om API-nyckeln är specifik för användarorganisationen, inte för IT-leverantören. Användarorganisationen skapar och administrerar alltså själv API-nyckeln och skickar den till IT-leverantören. Om användarorganisationen har flera integrationer ska en separat API-nyckel beställas för varje integration.
- När du skapar ett nytt användarnamn ska du ange den e-postadress som du i fortsättningen vill använda för att identifiera dig i tjänsten och hantera API-nyckeln.
- Observera att API-nyckeln i fortsättningen endast kan hanteras med denna e-postadress.
- Det rekommenderas att e-postadressen som anges som användarnamn är gemensam för organisationen och inte används av endast en person.
Logga in i tjänsten
- Gå till tjänsten: produktionsmiljöns administrationsgränssnitt för API-nycklarÖppnas i ett nytt fönster. eller kundtestmiljöns administrationsgränssnitt för API-nycklarÖppnas i ett nytt fönster.
- Ange den e-postadress du valt
- Vi skickar en bekräftelsekod till e-postadressen
- Skriv in bekräftelsekoden du fått i administrationsgränssnittet för API-nycklar
Lägg till uppgifter om användarorganisationen
- Uppgifter om organisationens
- Uppgifter om organisationens kontaktperson
Skapa och leverera den integrationsspecifika API-nyckeln
Du kan skapa flera API-nycklar för olika integrationer (högst 10 st.).
- Välj skapande av en ny API-nyckel
- Komplettera uppgifterna om integrationen och den IT-leverantör som genomför den (om annan än användarorganisationen).
- Skapa API-nyckel
- Kopiera API-nyckeln (se bilden nedan) och skicka den till din IT-leverantör via krypterad e-post eller på något annat informationssäkert sätt.Logga in i tjänsten
- Gå till tjänsten: produktionsmiljöns administrationsgränssnitt för API-nycklarÖppnas i ett nytt fönster. eller kundtestmiljöns administrationsgränssnitt för API-nycklarÖppnas i ett nytt fönster.
- Ange den e-postadress du valt
- Vi skickar en bekräftelsekod till e-postadressen
- Skriv in bekräftelsekoden du fått i administrationsgränssnittet för API-nycklar
Lägg till uppgifter om användarorganisationen
- Uppgifter om organisationens
- Uppgifter om organisationens kontaktperson
Skapa och leverera den integrationsspecifika API-nyckeln
Du kan skapa flera API-nycklar för olika integrationer (högst 10 st.).
- Välj skapande av en ny API-nyckel
- Komplettera uppgifterna om integrationen och den IT-leverantör som genomför den (om annan än användarorganisationen).
- Skapa API-nyckel
- Kopiera API-nyckeln (se bilden nedan) och skicka den till din IT-leverantör via krypterad e-post eller på något annat informationssäkert sätt.
API-nyckeln är giltig i ett år från tidpunkten för skapandet och giltighetstiden kan förlängas med ett år i taget.
Hantering av API-nycklar
- Du kan skapa en ny API-nyckel.
- Du kan förlänga den valda API-nyckelns giltighetstid (högst ett år i taget från tidpunkten för förlängningen).
- Du kan ta den valda API-nyckeln ur bruk.
Observera att
- API-nycklarna är integrationsspecifika och de kan vara högst 10 stycken.
Vad ska jag göra om den e-postadress som använts för att skapa API-nyckeln inte längre är i bruk?
- Skapa en ny API-nyckel för organisationen med en ny e-postadress.
- Kontakta oss på ptv-tuki@dvv.fi för att stänga den gamla API-nyckeln. API-nyckeln stängs senast om ett år, men det är säkrare att be att API-nyckeln stängs redan tidigare och att ta i bruk den nya API-nyckeln.
Länk till kundtestmiljön | Beskrivning |
|---|---|
Kundtestmiljöns administrationsgränssnitt för API-nycklarÖppnas i ett nytt fönster. | Beställning och hantering av API-nyckel |
Kundtestmiljöns gränssnittsdokumentation Öppnas i ett nytt fönster. | Dokumentation för gränssnittsversion 12 (Scalar) |
Gränssnittets tekniska adress (med API-nyckel): https://api-gw.palvelutietovaranto.trn.suomi.fi | Använd för programmässiga gränssnittsanrop med API-nyckel (t.ex. curl). |
Länk till produktionsmiljön (betaversion) | Beskrivning |
|---|---|
Produktionsmiljöns administrationsgränssnitt för API-nycklar Öppnas i ett nytt fönster. | Beställning och hantering av API-nyckel |
Produktionsmiljöns gränssnittsdokumentation Öppnas i ett nytt fönster. | Dokumentation för gränssnittsversion 12 (Scalar) |
Gränssnittets tekniska adress: https://api-gw.palvelutietovaranto.suomi.fi | Använd för programmässiga gränssnittsanrop med API-nyckel (t.ex. curl). Obs! Sökgränssnittet för gränssnittsversion 12 är i produktion som betaversion. |
Lägg till API-nyckeln i gränssnittsanropets HTTP-headers med nyckeln x-api-key.
Exempel på användning av API-nyckel i kundtestmiljön (curl)
curl 'https://api-gw.palvelutietovaranto.trn.suomi.fi/api/v12/municipality-codes?page=1&pageSize=10' -H 'x-api-key: skriv-in-API-nyckeln-här'Exempel på användning av API-nyckel i API-dokumentationens (scalar) anrop
Det lönar sig att ta i bruk API-nyckeln på huvudnivå. Då tas den automatiskt med i enskilda gränssnittsanrop (se figuren nedan):
- Gå till API-dokumentationens (scalar) övre del
- Välj under Authentication: apiKeyHeader
- Kopiera din API-nyckels värde till avsnittet: Value
-d720f40441ef65ca8cbd8f00fbd2994c.WEBP)