Ulospäin tarjottavia rajapintoja:
Rajapintojen autentikaatio toteutetaan CAS:n avulla. Lisätietoja käytöstä: Rajapintojen autentikaatio ja Rajapintojen kutsuesimerkkejä.
Huom. Suurin osa hakurajapinnoista ovat avoimia(opendata). Myös näiden opendata -rajapintojen käyttöön vaaditaan jatkossa kevyt autentikaatio (edellyttää rekisteröitymistä).
Asiakastoteutukset eri ohjelmointikielillä
Organisaatiot:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | OPENDATA |
|---|---|---|---|---|---|
| Organisaation hakurajapinta | REST/JSON | Rajapinta organisaatioiden(korkeakoulut, tiedekunnat, jne,) hakuun organisaatiopalvelusta | Tuotannossa | Organisaatiopalvelun swagger-dokumentaatio | Kyllä |
| Organisaatioiden tuontirajapinta | REST/JSON | Rajapinta organisaatiotietojen tuontiin organisaatiopalveluun | Tuotannossa | Organisaatiopalvelun swagger-dokumentaatio |
Opiskeluoikeudet ja suoritukset:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | OPENDATA |
|---|---|---|---|---|---|
| Opiskeluoikeus tiedonsiirto ammatillisista oppilaitoksista | REST/JSON | Haetaan oppilaitoksista tieto oppijoiden voimassaolevista opiskeluoikeukista. Toisen asteen valinnoissa rajoituksia, jos henkilöllä on voimassaoleva opiskeluoikeus. | 2015? | ||
| Tutkintosuoritus tiedonsiirto lukioista ja ammatillisista oppilaitoksista | REST/JSON | Haetaan oppilaitoksista tieto suoritetuista tutkinnoista. | ? | ||
| Arvosanatietojen siirtäminen lukioista ja ammattillisista oppilaitoksista | REST/JSON | Oppijoiden arvosanatietojen siirto keskitettyyn rekisteriin josta ne hyödynnettävissä opiskeijavalinnan ja muissa siirtymisissä oppilaitoksesta toiseen. | 2015 | ||
| Perusopetuksen päättöluokkalaisten perustietojen siirto (vrt. opiskeluoikeus) | XML/Excel/virkailija-avusteinen eräsiirto | Siirretään tieto siitä missä koulussa ja luokalla perusopetuksessa tai nivelvaiheessa opiskeleva oppija opiskelee. Huom. siirtoformaatti emuloi KOULUTAN tiedonsiirtoa. Tulee pidemmällä tähtäimellä korvautumaan modernimmalla ratkaisulla. | Tuotannossa | Perusasteen päättöluokkalaisten perustietojen siirrot | |
| Perusopetuksen päättöluokkalaiseten arvosanasiirto | XML/Excel/virkailija-avusteinen eräsiirto | Siirretään perusopetuksen päättöluokan ja lisäopetuksen päättöarviointi (arvosanat) oppilaitoksista opintopolkuun. Huom. siirtoformaatti emuloi KOULUTAN tiedonsiirtoa. Tulee pidemmällä tähtäimellä korvautumaan modernimmalla ratkaisulla. | 10, 5/2014 | Arvosanatietojen siirto oppilaitoksista opintopolkuun |
Koulutustarjonta ja haku:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | Opendata |
|---|---|---|---|---|---|
| Koulutustarjonnan hakurajapinta (koulutusinformaatio) | REST/JSON | Opintopolkuun tallennetun koulutustarjonnan julkinen rajapinta. Käytännössä tämä rajapinta tarjoaa opintopolku.fi julkisella puolella näytettävää dataa valmiiksi "rikastetussa" muodossa ja search operaatiota varten indeksoituna. Käytännössä joukko erillisiä resursseja. | Tuotannossa KK-tarjontaa julkaisussa 10, 5/2014 | Koulutusinformaation (koulutustarjonnan haku ja selailu) REST API | Kyllä |
| Koulutustarjonnan tuontirajapinta | REST/JSON | Rajapinta koulutusten sekä hakukohteiden tuontiin. Joukko erillisiä resursseja | Tuotannossa | Tarjonnan swagger-dokumentaatio | |
| Haun hakurajapinta | REST/JSON | Rajapinta josta voi hakea opiskelupaikkahaun tietoja (esim. korkeakoulujen yhteishaku) | Tuotannossa | Tarjonnan swagger-dokumentaatio | Kyllä |
| Haun tuontirajapina | REST/JSON | Rajapinta jolla voi luoda hakuja | Tuotannossa | Tarjonnan swagger-dokumentaatio |
Koodistot:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | OPENDATA |
|---|---|---|---|---|---|
| Koodiston hakurajapinta | SOAP | SOAP WS rajapinta koodistojen hakuun koodistopalvelusta | Tuotannossa | Rajapintakuvaukset | Kyllä |
| Koodiston hakurajapinta | REST/JSON/XML/XSD | Rest rajapinta koodistojen hakuun | Tuotannossa | Koodistopalvelun Rest -rajapinnat | Kyllä |
| Koodiston tuontirajapinta | SOAP | SOAP WS rajapinta koodistojen tuontiin koodistopalveluun | Tuotannossa | Rajapintakuvaukset | |
| Koodiston tuontirajapinta | REST/JSON/XML | Rest rajapinta koodistojen tuontiin koodistopalveluun | Tuotannossa | Swagger dokumentaatio |
Oppijanumerot:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | OPENDATA |
|---|---|---|---|---|---|
| Oppijanumeron luonti ja hakurajapinta | REST/JSON | rajapinta, jonka kautta ulkoinen palvelinjärjestelmä voi hakea ja lisätä uusia Henkilöitä järjestelmään. Käytetään hakemaan tietoa yksilöidyistä Henkilöistä joko OID:n tai henkilötunnuksen perusteella. Toteuttaa myös uusien henkilöiden luontipalvelun, jolla voidaan luoda henkiöitä joilla ei ole henkilötunnusta. | Tuotannossa | Oppijanumeron luonti ja hakurajapinta | Kyllä |
Hakemukset ja henkilöt:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | Opendata |
|---|---|---|---|---|---|
| Hakemusten hakurajapinta | REST/JSON | Rajapinta hakemusten hakuun | Tuotannossa | Hakemuspalvelun REST API | |
| Henkilöiden hakurajapinta | REST/JSON | Palauttaa henkilöiden tietoja haettaessa oppijanumerolla. | Tuotannossa |
Valintojen toteuttaminen ja valintojen tulokset:
Valinnan rajapintoja sisäisessä käytössä. Ulospäin tarjotaan koosteisia, tietosisällöltään ja ominaisuuksiltaan karsittuja rajapintoja.
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | Opendata |
|---|---|---|---|---|---|
| Vastaanottotiedon ja lukuvuosi-ilmoittautumisen tuontirajapinta | REST/JSON | Tuodaan opiskelijoiden vastaanottotietoja ja lukuvuosi-ilmoittautumistietoja opiskelijavalintareksiteriin. | 11, 10/2014 | ||
| Hakeneiden ja valittujen tietojen siirto toisen asteen oppilaitoksiin | XML/Excel/virkailija-avusteinen eräsiirto | Hakeneiden ja valittujen tietojen siirto toisen asteen oppilaitoksiin. Huom. siirtoformaatti emuloi KOULUTAN tiedonsiirtoa. Tulee pidemmällä tähtäimellä korvautumaan modernimmalla ratkaisulla. | Tuotannossa | Hakeneet ja paikan vastaanottaneet | |
| Hakeneiden ja valittujen tietojen siirto toisen asteen oppilaitoksiin | REST/JSON/XML/Excel/ | Hakeneiden ja valittujen tietojen siirto toisen asteen oppilaitoksiin. REST-resurssi tiedon hakuun (sovellus-sovellus yhteys) | Tuotannossa | https://virkailija.opintopolku.fi/suoritusrekisteri/swagger/index.html#!/hakijat/haeHakijat |
ePerusteet:
| Rajapinta | Tekniikka | Kuvaus | Julkaisu | Dokumentaatio | Opendata |
|---|---|---|---|---|---|
| Perusteiden vientirajapinta | REST/JSON | Rajapinta perusteiden hakuun | 04/2015 | Kyllä |