Page History

Yleiskuva rajapinnoista ja käyttöoikeusmenettelyistä

Käyttötapaus	Avoin	API-avain	Client credentials	OAuth2.0 user access token
Palvelusuosittelu
Palvelusuositusten pyytäminen
Palautteen antaminen suosituksista
Käyttäjäattribuuttien siirto suositeltuun palveluun palvelusiirtymän aikana
Siirrettyjen käyttäjäattribuuttien haku palvelusiirtymän jälkeen (avoin, jotta käytettävissä suoraan frontend-koodissa)
Profiilinhallinta
Käyttäjän attribuuttien haku
Käyttäjän attribuuttiosoittimien lisäys
Käyttäjän attribuuttiosoittimien poisto (ei vaadi access tokenia, jotta osoittimet voidaan poistaa deaktivoinnin jälkeenkin)
OAuth2.0
OpenID Connect -konfiguraatio
Profiilinhallinnan julkiset avaimet tokeneiden tarkistukseen
Luvitussivu, jolla käyttäjä antaa luvan tietoihinsa
Käyttäjän tokeneiden haku
Käyttäjän tokeneiden kumoaminen
Luvitetun käyttäjän tietojen haku

Luvitustavat

Anchor
luvitus-avoin luvitus-avoin

Avoin

Mitään luvitusta ei vaadita.

Anchor
luvitus-api-avain luvitus-api-avain

API-avain

Turvasähköpostilla välitetty palvelun API-avain annetaan pyynnön X-API-Key headerissa.

Anchor
luvitus-client-credentials luvitus-client-credentials

Client credentials

Palvelun client_id ja turvasähköpostilla välitetty client_secret annetaan Authorization headerissa (Authorization: Basic base64("client_id:client_secret"))

Anchor
luvitus-oauth-user-access-token luvitus-oauth-user-access-token

OAuth2.0 access token

Käyttäjäkohtainen access token, joka annetaan Authorization headerissa (Authorization: Bearer <access token>). Access tokenin muodostus:

1. Käyttäjä ohjataan rajapintaan "Luvitussivu, jolla käyttäjä antaa luvan tietoihinsa", parametrissa scope mitä tietoja käyttäjästä halutaan tallentaa tai hakea.
2. Käyttäjän antaessa luvan, ohjautuu käyttäjän selain palvelulle määritettyyn redirect_uriin authorization_coden kanssa.
3. Saatu authorization_code annetaan rajapintaan "Käyttäjän tokeneiden haku".
4. Paluuarvona saadaan käyttäjän access token ja refresh token.
5. Access tokenia voidaan nyt käyttää luvitusta vaativiin rajapintoihin. Access tokenin expiroituessa refresh tokenia voidaan käyttää "Käyttäjän tokeneiden haku" rajapintaan hakemaan uusi access token ja refresh token.

OAuth2.0 scopet

Tuetut scopet on listattu rajapinnassa "OpenID Connect -konfiguraatio" kohdassa "scopes_supported". Karkeasti yksittäinen scope antaa luvan:

...