Tiedon hyödyntäjille ja kehittäjille

PalveluYdin rajapinnat

PalveluYdin rajapinnat

PalveluYdin tarjoaa kohdejärjestelmille lukurajapinnan polussa `/api/public`.

• Lukurajapinta on toteutettu JSON RESTful -tyylillä ja pääsyoikeudet luvitetaan Helsingin kaupungin API Gatewayn avulla.

Ajantasainen rajapintakuvaus on nähtävillä stage-ympäristössä osoitteessa  
https://stage.palveluydin.hel.fi/api/swagger-ui/index.html?urls.primaryName=Public+API

Nykyinen `/api/public` on toteutettu v0-lukurajapintana. Rajapinnan kautta voi hakea tietoa tällä hetkellä esimerkiksi seuraavista tietokokonaisuuksista:

• palvelut
• palvelupaikat
• verkkoasiointikanavat
• verkkosivut
• puhelinasiointikanavat
• tulostettavat lomakkeet
• organisaatiot
• palvelukokonaisuudet
• asiasanat

Lisäksi rajapinnassa on käytössä health-tarkistusrajapinta.

Rajapinta tukee tällä hetkellä lukukäyttöä eli GET-kutsuja. Listausrajapinnoissa on käytössä sivutus sekä rajapintakuvauksen mukaisia lajittelu- ja suodatusmahdollisuuksia.

Rajapintaa kehitetään edelleen projektin edetessä, ja kehitystyössä osallistetaan kohdejärjestelmien edustajia parhaan lopputuloksen saavuttamiseksi.

API-avaimen rajapinnan testaamiseen voi hakea Kati Seppälältä (kati.seppala@hel.fi) tai Henna Niemeltä (henna.niemi@hel.fi).

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 PalveluYtimen rajapintoihin tulee vaatimaan toimenpiteitä kaikissa kohdejärjestelmissä.

TPR-rajapintojen poistumisaikataulusta tiedotetaan tarkemmin vuoden 2027 aikana. Alustavasti alasajoa on kaavailtu vuoden 2028 alkupuoliskolle.

Siirtymän suunnittelu kannattaa kuitenkin aloittaa hyvissä ajoin, koska korvaava `/api/public`-rajapinta on jo toteutettu ja sitä kehitetään edelleen.

PalveluYdin ja kirjautuminen

PalveluYtimen käyttöliittymässä on 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 tunnistautumisratkaisua.

Lisätietoja: https://profiili.hel.fi/guide

Rajapintojen käyttöoikeudet hallitaan erikseen Helsingin kaupungin API Gatewayn kautta. API-avaimen rajapinnan testaamiseen voi hakea Kati Seppälältä (kati.seppala@hel.fi) tai Henna Niemeltä (henna.niemi@hel.fi).