API-avain on tarkoitettu rajapinta integraatioihin. API-avaimen avulla kontrolloit ketkä ulkopuoliset pystyvät käyttämään yrityksesi tietoja rajapinnan läpi. API-avain siis lisää tietosuojaa ja antaa sinulle mahdollisuuden estää rajapinnan käyttö tarvittaessa. Jos taas itse teet integrointeja, niin API-avaimen avulla näet kenelle olet integraatioita tehnyt eli myöntänyt API-avaimen.
API-avainten hallinta on yritystiedoissa välilehdellä API-avaimet. Yrityksen omat API-avaimet ovat niitä, jotka luot itse. Voit luoda useita API-avaimia esimerkiksi erilaisia integraatioita varten. Myönnä yritykselle -toiminnolla annat API-avaimen käyttöoikeudet toiselle yritykselle. Näet myöntämäsi API-avaimen kohdasta myönnetyt API-avaimet.
Saadut API-avaimet ovat sitten niitä, joita yrityksesi käyttää integraatiossa. Voit myös myöntää API-avaimen omalle yrityksellesi.
API-avain on yksilöllinen GUID merkkijono.
Käydään asia läpi esimerkin kautta. Integraattori Oy tekee kauppapaikkaintegrointeja ja heille tuli uutena asiakkaana Lemonsoft asiakas nimeltään Tukkukauppa Oy.
Integraattori perustaa oman yrityksensä käyttäjähallintaan. Integraattori ei itse käytä Lemonsoftia, joten ympäristö tietoja ei ole. Integraattori luo itselleen uuden API-avaimen ja myöntää Tukkukauppa Oy:lle käyttöoikeuden. Integraattori koodaa integroinnin Tukkukauppa Oy:n API-avaimella ja Tukkukaupan perustamalla paikallisella käyttäjällä.
API-avaimen luonti
Integraattori eli kolmas osapuoli, joka tekee integroinnin Lemonsoftin rajapinnan avulla, tarvitsee API-avaimen.
Integraattori saa API-avaimen joko pyytämällä Lemonsoftilta tai luomalla avaimen itse. Avaimen luonti tapahtuu yritystietojen API-avaimet -välilehdellä Luo uusi avain -toiminnolla. Anna avaimelle kuvaava selite, esimerkiksi ’Kauppapaikat’.
Kun olet luonut API-avaimen, myönnä sen käyttöoikeus yritykselle, jolle teet integraatiota. Voit myöntää API-avaimen usealle eri yritykselle. Tee myöntäminen toiminnolla Myönnä yritykselle. Toiminto kysyy y-tunnuksen ja yksikkötunnuksen. Voit myöntää yhdelle yritykselle vain yhden API-avaimen. Yrityksen yhteyshenkilö saa sähköpostin myönnetystä API-avaimesta.
API-avaimen poistaminen
Voit poistaa luomasi API-avaimen Poista -toiminnolla. Tällöin yrityksistä, joille olet myöntänyt API-avaimen käyttöoikeuden, poistuu API-avain. API-avaimen poiston jälkeen sen avulla tehdyt integroinnit eivät enää toimi. Poistosta menee sähköposti yrityksen yhteyshenkilölle.
Mikäli olet saanut API-avaimen, voit myös itse poistaa sen. Tällöin se poistuu vain yrityksesi osalta ja sillä tehty integraatio lakkaa toimimasta.
Kun poistat API-avaimen, niin tehdyt integraatiot eivät enää toimi. Vaikka myönnät uuden API-avaimen, täytyy uusi API-avain kertoa integraatiokoodiin ennenkuin rajapinta taas on käytössä.