Rajapintojen käytön seurannan ja paremman kehittäjätuen mahdollistamiseksi tulee Opintopolkuun integroituvien järjestelmien lisätä "Caller-Id"-HTTP-otsikko kaikkiin rajapintakutsuihin. Tunnus on muotoa <organisaation oid>.<järjestelmän nimi> eli esimerkiksi jos Helsingin yliopiston Oodi-järjestelmä kutsuu Opintopolun rajapintaa, Caller-Id on "1.2.246.562.10.53814745062.oodi". Käytettävä järjestelmän nimi on kutsuvan tahon päätettävissä. Jos organisaatiolla ei ole oidia niin siinä osassa voi käyttää organisaation nimeä (ilman ääkkösiä).

Caller-Id:n sijasta on aikaisemmin välillä käytetty clientSubSystemCode-arvoa, mutta tästä pyritään eroon.


Caller-Id tulee pakolliseksi kahdessa vaiheessa.

Ensimmäinen vaihe on jo otettu käyttöön alkaen 9.3.2020 seuraavien palveluiden rajapinnoissa: koodisto, organisaatio, tarjonta, eperusteet, eHOKS.

Toisessa vaiheessa Caller-Id tulee pakolliseksi kaikkiin muihin rajapintoihin seuraavalla aikataululla:

  1. Caller-Id otetaan käyttöön Q&A-ympäristössä maanantaina 7.9.2020
  2. Caller-Id otetaan tuotantokäyttöön keskiviikkona 28.10.2020

Sallitut merkit

Sallittuja merkkejä ovat aakkoset (a-z, ei esim. å, ä ja ö), numerot (0-9), piste (.), viiva (-) ja alaviiva (_). 

Esimerkki pyynnöstä Caller-Id:n kanssa:

Tässä vielä esimerkki yllämainitun esimerkkitapauksen http-pyynnöstä (Oodi kutsuu Opintopolun tarjontapalvelun rajapintaa):

GET /tarjonta-service/rest/v1/haku HTTP/1.1
Host: virkailija.testiopintopolku.fi
Caller-Id: 1.2.246.562.10.53814745062.oodi

OPH:n sisäisten palvelujen tekemät kutsut:

Näissä kutsuissa käytetään seuraavaa organisaatio-oidia:

"1.2.246.562.10.00000000001"

Sähköpostijakelulista oph-api@postit.csc.fi

API:hin liittyviä teknisiä tiedotteita varten on perustettu sähköpostijakelulista. Jos haluat liittyä jakelulistalle noudata alla olevia ohjeita.

Näin liityt sähköpostin jakelulistalle:

Lähetä viesti osoitteeseen sympa@postit.csc.fi osoitteesta johon jatkossa haluat viestien tulevan. Viestin otsikko-kenttään kirjoita: "subscribe oph-api etunimi koko_nimi". Vaihda kohtaan etunimi oma etunimesi ja kohtaan koko_nimi oma nimesi. Jätä viestikenttä tyhjäksi.

Näin poistut sähköpostin jakelulistalta:

Lähetä viesti osoitteeseen sympa@postit.csc.fi osoitteesta johon et jatkossa enää halua viestien tulevan. Viestin otsikko-kenttään kirjoita: "unsubscribe oph-api".