Tiedon hyödyntäjille ja kehittäjille
Tällä sivulla kerrotaan mm rajapintoihin liittyvistä asioista.
PalveluYdin rajapinnat
Rajapintoja kehitetään vaiheittain
PalveluYdin tulee tarjoamaan lukurajapinnat kohdejärjestelmille, joista esimerkiksi kaupunkien verkkosivut voivat jatkossa hakea palvelutietoa. Lukurajapinnat toteutetaan JSON RESTful-tyylillä ja pääsyoikeudet luvitetaan Helsingin kaupungin API Gatewayn avulla.
Rajapintoja kehitetään projektin edetessä, ja kehitystyössä osallistetaan kohdejärjestelmien edustajia parhaan lopputuloksen saavuttamiseksi.
- Ensimmäinen kommentoitava rajapintakuvaus on nähtävillä osoitteessa https://stage.palveluydin.hel.fi/api/swagger-ui/index.html?urls.primaryName=Public+API.
Huomioithan, että kyseessä on ainoastaan rajapintakuvaus, eikä sen kautta ole vielä mahdollista toteuttaa kutsuja. Rajapintakuvauksen toisessa versioissa mahdollistetaan kutsujen tekeminen, jotta toteutusta voi tarvittaessa testata. Toisen version julkaisu on ajoitettu tapahtuvan ennen vuoden 2026 juhannusta. Julkaisusta tiedotetaan kohdejärjestelmiä erikseen.
Voinko jatkaa TPR-rajapintojen käyttöä?
PalveluYdin tulee korvaamaan TPR-perheen Toimipisterekisterin, Palvelukuvausrekisterin sekä organisaatiosovelluksen. Tässä yhteydessä myös vanhat TPR-rajapinnat poistuvat käytöstä. Siirtyminen PalveluYdin rajapintoihin tulee vaatimaan toimenpiteitä kaikissa kohdejärjestelmissä.
TPR-rajapintojen poistumisaikataulusta tiedotetaan tarkemmin vuoden 2027 aikana. Alustavasti alasajoa on kaavailtu vuoden 2028 alkupuoliskolle.
PalveluYdin ja kirjautuminen
Käytössä AD/EntraID kirjautuminen eli käyttäjät eivät tarvitse kirjautumiseen erillisiä tunnuksia. Käyttäjä tunnistetaan automaattisesti AD/EntraID tunnukseen perustuen.
PalveluYdin käyttää työntekijöiden tunnistautumiseen Helsingin kaupungin tunnistautumissratkaisua. Lisätietoja: https://profiili.hel.fi/guide
Integraatiopalvelu ja API Gateway
PalveluYdin tulee hyödyntämään Helsingin kaupungin uutta integraatiopalvelua.
Integraatiopalvelu koostuu viidestä osa-alueesta: Hallinta ja asiakasyhteistyö, suunnittelun palvelut, kehityksen palvelut, ylläpidon ja valvonnan palvelut sekä migraatiot. Näiden avulla varmistetaan, että integraatiot voidaan suunnitella, toteuttaa, ylläpitää ja tarvittaessa siirtää uuteen ympäristöön hallitusti.
Konkreettisia komponentteja integraatiopalvelussa ovat integraatioalusta, jonne integraatioita toteutetaan, sekä API-gateway, jonka kautta tarjotaan API:ja suojatun ympäristön kautta.
Mikä on API Gateway?
API Gateway on kuin portti, joka hallinnoi ja ohjaa liikennettä eri palveluiden välillä. Se toimii yhdistävänä tekijänä, joka ottaa vastaan pyyntöjä käyttäjiltä ja ohjaa ne oikeisiin taustapalveluihin. API Gateway on turvallisempi kuin avoin rajapinta. Tietoturvaan liittyviä toiminnallisuuksia on mm. käyttäjien suojaus luvattomilta käytöiltä, tietoturvauhkien tunnistaminen ja torjunta.