Käyttöohjeet: Arvo-API-osion käyttäminen

 

Arvo-API-osio on rajapintatunnuksen ylläpitosivu, jolle pääsee käyttöoikeudella Arvo-rajapintakäyttäjä. Saadaksesi Arvo-API-rajapinnan käyttöösi, toimi näin:

1. Luo API-avain.

2. Kopioi API-avain itsellesi talteen.

3. Syötä rajapintaa hallinnoivan henkilön sähköpostiosoite sekä IP-osoite ja tallenna ne Arvo-API-sivulla. Sähköposti voi olla myös organisaatiosähköpostiosoite, esim. tietohallinto@koulutuksenjarjestaja.fi.

5. Odota sähköpostitse saapuvaa vahvistusta siitä, että IP-osoite on avattu ja rajapinta on otettavissa käyttöön.


Käyttöohje:

1 Valitse ylävalikosta osio Arvo-API.


2 Näet seuraavat ohjetekstit:


Toimita rajapintatunnus ja API-avain oman organisaatiosi rajapintoja kutsuvalle taholle.


Linkki ohjeisiin: Arvo-API:n dokumentaatio Wikissä


Koulutuksen järjestäjän rajapintatunnus

Rajapinta ei ole vielä käytössä. Luo API-avain ja tallenna sähköpostiosoite ja rajapintaa kutsuva IP-osoite ottaaksesi rajapinnan käyttöön.


API-avain

Luo API-avain ja kopioi API-avain itsellesi talteen, sillä se ei jää näkyviin tälle sivulle. Toimita API-avain rajapintoja kutsuvalle taholle mahdollisimman pian, jotta voitte jatkaa rajapinnan käyttöä keskeytyksettä.



3 Klikkaa painiketta "Luo API-avain".



4 Näet luodun API-avaimen ja voit kopioida sen itsellesi talteen.


Näet oheisen uuden tekstin:

Koulutuksen järjestäjän rajapintatunnus

API-avain päivitetty xx.xx.xxxx. Saat sähköpostitse vahvistuksen, kun rajapinta on otettavissa käyttöön.



Painike on vaihtunut painikkeesta "Luo API-avain" painikkeeksi "Vaihda API-avain". Katso ohjeet API-avaimen vaihtamisesta kohdasta 7.


5 Syötä sähköpostiosoite, jotta voit saada sähköpostitse vahvistuksen, kun rajapinta on otettavissa käyttöön. Syötä IP-osoite otsikon "Koulutuksen järjestäjän rajapintaa kutsuva IP-osoite" alta löytyvään kenttään. Klikkaa painiketta "Tallenna".



6 Näet ilmoituksen sähköpostiosoitteen ja IP-osoitteen tallennuksen onnistumisesta. Näet sähköpostiosoitteen ja IP-osoitteen alla tekstin: "Tiedot päivitetty xx.xx.xxxx".


7 Jos haluat vaihtaa API-avaimen, voit klikata painiketta "Vaihda API-avain". Näet varmistuksen "API-avaimen vaihtaminen estää rajapinnan käytön kunnes tunnus vaihdetaan rajapintaa kutsuvassa sovelluksessa. Haluatko varmasti vaihtaa API-avaimen?" Hyväksy varmistus OK-painikkeesta, jos haluat vaihtaa API-avaimen, tai hylkää varmistus Peruuta-painikkeesta, jos et haluakaan vaihtaa API-avainta.