Historia
20.3.2017 Ensimmäinen versio
Yleistä
Finnassa on rajapinta, jolla voidaan tarkistaa, ovatko asiakkaan antamat kirjautumistiedot oikein. Rajapinta palauttaa vain tiedon onnistumisesta, ei asiakkaan tietoja. Rajapinta ei ole avoimesti käytettävissä, vaan sen käytöstä ja kattavuudesta sovitaan erikseen.
Merkistönä on kaikissa tapauksissa UTF-8 (composed).
Toiminnot
getLoginTargets
https://api.finna.fi/api/v1/auth/getLoginTargets?<parametrit>
Palauttaa listan targeteista (kirjastot), joihin kirjautumispyynnön voi kohdistaa. Kertoo vastauksessa myös, mikäli kirjautuminen edellyttää myös toissijaisen tiedon käyttämistä (tyypillisesti sukunimi kirjastokortin numeron ja PIN-koodin lisäksi).
Parametri | Tyyppi | Selite | Sallitut arvot |
---|---|---|---|
prettyPrint | Luku | Tulostetaanko JSON rivinvaihtojen kera | 0 (oletus), 1 |
lng | Merkkijono | Kieliversio |
|
Esimerkkikysely:
https://api.finna.fi/api/v1/auth/getLoginTargets?prettyPrint=1
Esimerkkivastaus:
{ "targets": [ { "id": "muumilaakso", "name": "Muumilaakson kirjasto", }, { "id": "testi", "name": "Testikirjasto", "secondary_login_field_label": "Sukunimi" } ] }
libraryCardLogin
Palauttaa tiedon kirjautumisen onnistumisesta ja mahdollisista virheistä. Parametrit tulee lähettää POST-pyynnöllä (application/x-www-form-urlencoded; charset=utf-8).
Parametri | Tyyppi | Selite | Sallitut arvot |
---|---|---|---|
prettyPrint | Luku | Tulostetaanko JSON rivinvaihtojen kera | 0 (oletus), 1 |
lng | Merkkijono | Kieliversio |
|
target | Merkkijono | Kirjautumiskohde eli kirjasto | getLoginTargets-pyynnön palauttamat id:t |
username | Merkkijono | Käyttäjätunnus (kirjastokortin numero) | |
password | Merkkijono | Salasana (PIN-koodi) | |
secondary | Merkkijono | Toinen tunnistekenttä, mikäli getLoginTargets palautti secondary_login_field_label:n |
Esimerkkikysely (tässä GET-muodossa, käytä POST-pyyntöä):
https://api.finna.fi/api/v1/auth/libraryCardLogin?target=muumilaakso&username=100010&password=12345&secondary=Muumipappa
Esimerkkivastaus onnistuneesta kirjautumisesta:
{"result":"success","status":"OK"}
Esimerkkivastaus epäonnistuneesta kirjautumisesta (tunnus tai salasana väärä):
{"result":"failure","status":"OK"}
Esimerkkivastaus, jos esim. yhteydessä kirjastojärjestelmään on ongelmia:
{"status":"ERROR","statusMessage":"Backend unavailable"}