Metodi:
Kaikki kyselyt tehdään POST-metodilla.
Rajapinnat:
Kolme eri rajapintaa:
- Palvelut
Palvelun tiedoissa kerrotaan, mitä palvelua asiakas saa, kenelle palvelu on tarkoitettu, miten käyttäjä saa palvelun. Palvelulle annetaan myös sen sisältöä kuvaavat asiasanat ja luokittelut. Lisäksi palvelun tiedoissa on omat kenttänsä esimerkiksi maksullisuudelle, kielille ja aluetiedoille. Osa tiedoista on vapaita tekstikenttiä, osa vakioituja luokittelutietoja - Palvelukanavat
Palvelukanava kuvaa, mistä asiakas voi saada palvelun. Lisäksi palvelukanavien tiedoissa on omat kenttänsä esimerkiksi maksullisuudelle, palveluajoille, kielille ja aluetiedoille. Osa tiedoista on vapaita tekstikenttiä, osa vakioituja luokittelutietoja. - Organisaatiot
Organisaation tiedot sisältävät esimerkiksi organisaation yhteystiedot. Organisaatiolla voi olla myös alaorganisaatioita.
Tunnistautuminen:
Rajapinta vaatii tunnistautumisen API-avaimella, jonka saat käyttöönoton yhteydessä DigiFinlandilta. Käytä avainta user_key-headerissa. Mikäli avain puuttuu tai on virheellinen, rajapinta palauttaa HTTP-statuskoodin 403 ja vastauksen “Authentication failed”.
Kyselyn sijainti:
Hakuehdot sijoitetaan requestin bodyyn JSON-muodossa.
Vastaus:
Onnistuneen kyselyn jälkeen rajapinta palauttaa HTTP-statuskoodin 200 OK ja vastauksen JSON-muodossa.