API-avain on ainutlaatuinen tunniste, jota käytetään henkilöllisyytesi todentamiseen, kun teet pyyntöjä Europeanan API-rajapintoihin esimerkiksi kulttuuriperintökohteiden ja niiden metatietojen hakemiseksi.
Tarjoamme kahdenlaisia API-avaimia käyttötapauksestasi riippuen: Henkilökohtaiset ja projektin avaimet. Henkilökohtaiset avaimet on tarkoitettu API:n yksilölliseen tutkimiseen. Sen avulla voidaan selata saatavilla olevaa sisältöä, kokeilla päätepisteitä ja testata sovellusta, kun sitä kehitetään tai valmistellaan täyttämään projektiavaimen vaatimukset. Projektiavaimet on tarkoitettu henkilöille, jotka käyttävät Europeanan sovellusliittymiä palvelun toimittamiseen tai tietyn operatiivisen tarpeen tukemiseen.
Näin rekisteröidyt henkilökohtaiseen API-avaimeen
- Kirjaudu sisään tilillesi.
- Napsauta Oma profiili -sivulla käyttäjänimesi oikeassa reunassa olevaa nuolta ja valitse pudotusvalikosta Hallitse API-avainta. Vaihtoehtoisesti voit siirtyä ”Lisätietoja”-osioon, joka sijaitsee minkä tahansa Europeana.eu-verkkosivun alareunassa, ja napsauttaa ”Register for an API key” (Rekisteröidy API-avainta varten) päästäksesi API-hallintasivulle.
- Valitse ruutu ”Vahvistan, että olen lukenut ja hyväksynyt API-avaimen keskeiset käyttöehdot”, joka sijaitsee kohdassa ”Henkilökohtainen API-avain”.
- Napsauta ”Pyydä henkilökohtaista API-avainta” -painiketta, niin sinulle annetaan automaattisesti sellainen.
Jos haluat poistaa henkilökohtaisen API-avaimen käytöstä, napsauta henkilökohtaisen API-avaimesi oikealla puolella olevaa kolmea pistettä ja napsauta Poista avain käytöstä. Avain poistetaan käytöstä välittömästi. Jos haluat ottaa tämän API-avaimen uudelleen käyttöön, lähetä sähköpostia osoitteeseen api@europeana.eu tai käytä ikkunan alareunassa olevaa palautepainiketta. Jokaisella käyttäjällä voi olla yksi aktiivinen henkilökohtainen API-avain kerrallaan. Kun poistat sen käytöstä, voit pyytää uutta.
Näin rekisteröidyt projektiin API-avain
- Kirjaudu sisään tilillesi.
- Napsauta Oma profiili -sivulla käyttäjänimesi oikeassa reunassa olevaa nuolta ja valitse pudotusvalikosta Hallitse API-avainta. Vaihtoehtoisesti voit siirtyä minkä tahansa Europeana.eu-verkkosivun alareunassa olevaan ”Lisätietoja”-osioon ja napsauttaa ”Register for an API key” (Rekisteröidy API-avainta varten) päästäksesi API-hallintasivulle.
- Täytä ja lähetä lomake kohdassa ”Project API keys”. API-hallintatiimimme on yhteydessä tarkistaakseen tarpeesi ja arvioidakseen pyyntösi.
Jos haluat poistaa projektin API-avaimen käytöstä, napsauta projektin API-avaimen oikeassa reunassa olevaa kolmea pistettä ja napsauta Poista avain käytöstä. Avain poistetaan käytöstä välittömästi. Jos haluat ottaa tämän API-avaimen uudelleen käyttöön, lähetä sähköpostia osoitteeseen api@europeana.eu tai käytä ikkunan alareunassa olevaa palautepainiketta. Jokaisella käyttäjällä voi olla useita aktiivisia projektin API-avaimia samanaikaisesti.