TPR rajapinnat

Ennakkotieto

TPRn avoimet rajapinnat siirtyvät käyttämään syksyn aikana API Gatewayta

Tämä on ennakkotieto TPR perheen avoimia rajapintoja hyödyntäville käyttäjille, joten välitäthän tämän tiedon TPR rajapintoja käyttäville tahoille.

TPR siirtyy käyttämään avointen rajapintojen sijasta Helsingin kaupungin uutta yhteistä API Gatewayta syksyn aikana. Tämä tarkoittaa muutoksia aikaisempiin TPR rajapintojen URL osoitteisiin. Muutos koskee Toimipiste ja palvelukuvausrekisterin avoimia rajapintoja, muita TPR rajapintoja tämä muutos ei koske (esim. Palvelukartta, esteettömyyssovellus, aukiolosovellus, paikkatietohaku).

Nykyiset avoimet rajapinnat toimivat jonkin aikaa päällekkäin API Gatewayn kanssa, mutta suosittelemme, että siirrytte hyödyntämään API Gatewayta heti sen käyttöönoton  jälkeen. API Gatewayn käyttöönoton ajankohdasta tiedotamme heti kun saamme lisätietoja tarkasta ajankohdasta.

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. 

Mitä rajapinnan käyttäjien tulee huomioida kun muutos syksyllä astuu voimaan?

1. Endpointien muutokset

  • Uudet URL-osoitteet: Tarkista, ovatko API-endpointien URL-osoitteet muuttuneet. API-gatewayn käyttöönotto saattaa muuttaa endpointien osoitteita, ja käyttäjien täytyy päivittää nämä sovelluksiinsa.
  • Polkumuutokset: Varmista, että API-kutsut osoittavat oikeisiin polkuihin API-gatewayn kautta.

2. Autentikointi ja valtuutus

  • Uudet autentikointimenetelmät: API-gateway saattaa käyttää erilaisia autentikointimenetelmiä (kuten OAuth, JWT, API-avaimet). Käyttäjien täytyy ymmärtää ja implementoida uudet autentikointivaatimukset.
  • Valtuutuskäytännöt: Tarkista, onko pääsyoikeuksiin tullut muutoksia ja varmista, että sovelluksilla on edelleen oikeudet käyttää tarvittavia endpointteja.

3. Pyyntö- ja vastausmuutokset

  • Välimuistitus: API-gateway saattaa käyttää välimuistia pyyntöjen käsittelyyn. Käyttäjien täytyy olla tietoisia mahdollisista viiveistä ja välimuistitiedoista vastauksissa.
  • Throttle- ja rate-limiting: API-gateway voi asettaa rajoituksia pyynnöille. Käyttäjien täytyy olla tietoisia näistä rajoituksista ja implementoida sovelluksiinsa logiikka, joka käsittelee rajoitusten ylittämisen.

4. Suorituskyky ja luotettavuus

  • Uusi latenssi: API-gateway saattaa tuoda lisää latenssia API-kutsuihin. Käyttäjien on otettava tämä huomioon sovellustensa suorituskyvyssä.
  • Vikasietoisuus: Varmista, että sovellus pystyy käsittelemään mahdolliset virhetilanteet, joita voi ilmetä API-gatewayn kautta (esim. yhteysvirheet, aikakatkaisut).

5. Turvallisuus

  • SSL/TLS: API-gateway vaatii todennäköisesti SSL/TLS-yhteyksiä. Käyttäjien täytyy varmistaa, että heidän sovelluksensa tukevat HTTPS-yhteyksiä.
  • CORS-säännöt: Tarkista, ovatko CORS-säännöt muuttuneet, ja varmista, että sovellus pystyy tekemään CORS-pyyntöjä, jos ne ovat tarpeen.

TPR perheen rajapinnat

Esteettömyystiedot saa: