Digitaalisen API-palvelun käyttöönotto ja turvallinen käyttö
Tällä sivulla kuvataan lyhyesti, kuinka DigiFinlandin eri palvelut voidaan ottaa käyttöön hyvinvointialueiden omissa digipalveluissa ja alustoilla.
Sivu ohjeistaa, miten otat digitaalisen API-to-API-palvelun käyttöön tietoturvallisesti, hyväksyt sopimusehdot ja varmistat sujuvan integraation sovellusten välillä.
1. Käyttöönotto ja sopimusehtojen hyväksyntä
Palvelun käyttö edellyttää seuraavaa:
- Sopimusehtojen hyväksyminen ennen ensimmäistä käyttökertaa.
- Käyttöoikeuden rekisteröintiä organisaation nimissä.
- Käyttöönottopäivän vahvistaminen, joka toimii myös laskutuksen aloituspäivänä.
Huomio: Palvelu ei sisällä SLA-vaatimuksia. Käyttö tapahtuu ”as-is”-periaatteella, eikä palvelutasotakuuta ole.
2. API-to-API -integraatio
API-rajapinnat on suunniteltu sovellusten väliseen tiedonsiirtoon. Käyttöönotossa huomioitavaa:
- Rajapintakutsut vaativat API-avaimen käyttöä.
- Rajapinnat tukevat REST-muotoa.
- Rajapinnoista on saatavilla testi- ja tuotantoympäristöt.
3. Tietoturvallinen käyttö ja API-avain
Kaikki API-kutsut edellyttävät turvallista tunnistautumista API-avaimella, joka myönnetään rekisteröityneelle asiakkaalle.
API-avaimen hakeminen:
- Asiakas rekisteröityy ja saa käyttöoikeuden DigiFinlandin kehittäjäportaaliin.
- API-avain noudetaan kehittäjäportaalista. Kirjautuminen portaaliin tapahtuu käyttäjätunnuksella ja salasanalla. API-avain on organisaatio- ja palvelukohtainen.
- API-avain tallennetaan turvallisesti ja käytetään rajapintakutsuissa.
- Tarvittaessa API-avaimen voi luoda uudelleen kehittäjäportaalissa.
API-avaimen käyttö:
- API-avain välitetään API-kutsussa user_key -headerissa.
- API-avaimen käyttö on pakollista kaikissa rajapintakutsuissa.
4. Laskutus
Laskutus alkaa käyttöönoton vahvistuspäivästä ja etenee sopimuksen mukaisesti.
- Laskutus perustuu kiinteään kuukausihintaan, joka sovitaan asiakkaan kanssa solmittavassa sopimuksessa. DigiFinland pidättää oikeuden muuttaa hinnoittelua esimerkiksi palvelun tuottamiseen liittyvistä syistä. Mahdollisista muutoksista informoidaan asiakasta etukäteen.
- Käyttöraportit ovat saatavilla sopimuksessa määritellyillä tavoilla.
5. Tuki ja yhteydenotto
Mikäli olet kiinnostunut API-palveluista, voit olla yhteydessä lähettämällä viestin osoitteeseen: palvelut@digifinland.fi tai ottamalla yhteyttä oman alueesi asiakkuuspäällikköön. Asiakkuuspäälliköiden yhteystiedot löytyvät DigiFinlandin verkkosivuilta osoitteesta:
Yhteystiedot – DigiFinland
Esittelemme mielellämme palvelukokonaisuutta ja autamme organisaatiotasi aloittamaan palvelun käytön.