Kyseiset ohjeet koskevat uuden opintopolun tarjontaa ja opintopolku.fi:tä - kouta & konfo
Kouta (koulutustarjonta)
Tarjonnan (kouta) tietokanta
https://db-documentation.testiopintopolku.fi/kouta/public/index.html
Tarjonnan (kouta) sisäiset rajapinnat rajapinnat
https://virkailija.opintopolku.fi/kouta-backend/swagger/
Tarjonnan (kouta) ulkoisille integraatioille tarkoitetut rajapinnat
Sopii erityisesti jos halutaan hakea tallennettua koulutustarjontaa omiin järjestelmiin tai tuoda omista järjestelmistä
https://virkailija.opintopolku.fi/kouta-external/swagger/index.html (Swaggerillä voi käyttöliittymän kautta tehdä pyyntöjä palveluun ja tarkastella rajapintojen tietomallia.)
https://virkailija.opintopolku.fi/kouta-external/redoc/index.html (Redocissa voi tarkastella rajapintojen tietomallia jossa se on paremmin visualisoitu kuin swaggerissä.)
Konfo (opintopolku.fi)
Opintopolku.fi:n (konfo) sisäiset rajapinnat
https://opintopolku.fi/konfo-backend/swagger/index.html
Opintopolku.fi:n (konfo) ulkoiset rajapinnat - ei vaadi autentikaatiota
Sopii erityisesti jos halutaan hakea julkaistua koulutustarjontaa näkyviin omille verkkosivuille
https://opintopolku.fi/konfo-backend/swagger/index.html#/External
Ohjeita rajapintojen käyttöön
- CAS-autentikointi: https://wiki.eduuni.fi/x/L95cCw
- Caller-Id-header pyyntöihin: https://wiki.eduuni.fi/x/0MeKCg
- CSRF-tokenin lisääminen HTTP-kutsuihin: https://wiki.eduuni.fi/x/EL_hCw
Autentikointia tarvitaan tarjonnan (kouta) eri rajapintojen käyttöön. Julkisen puolen (uudistettu opintopolku.fi eli konfo) rajapintojen käyttämiseen ei tarvita autentikaatiota. Kaikkien rajapintojen käyttöön vaaditaan kuitenkin caller-id-header ja osaan pyynnöistä myös CSRF-token.