API-avain on tarkoitettu rajapinta integraatioihin. API-avaimen avain on yksilöllinen GUID merkkijono, jonka 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 -välilehdellä. 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 oman yrityksesi lisäksi myös toiselle yritykselle. Näet myöntämäsi API-avaimen kohdasta myönnetyt Myönnetyt API-avaimet.
Saadut API-avaimet ovat sitten niitä, joita yrityksesi käyttää integraatiossa. Voit myös myöntää API-avaimen omalle yrityksellesi. Tarvittaessa voit kopioida avaimen leikepöydälle tai muokata avaimen selitettä kuvan toiminnoilla.
| Tiedot |
|---|
Huomaa, että myös SOAP- ja REST-rajapintojen käyttäminen vaatii käyttäjän tunnistamisen.
|
...
|
...
Käydään asia läpi esimerkin kautta. Integraattori Oy tekee kauppapaikkaintegrointeja ja heille tuli uutena asiakkaana Lemonsoft asiakas nimeltään Tukkukauppa Oy.
...
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 Liitä valittu avain yritykseen. Toiminto kysyy y-tunnuksen ja yksikkötunnuksen. Voit myöntää yhdelle yritykselle vain yhden API-avaimenyksikkötunnuksen (yksikkötunnuksen näet esimerkiksi etusivun Yritykset -listasta). Yrityksen yhteyshenkilö saa sähköpostin myönnetystä API-avaimesta.
...
API-avaimen poistaminen
Voit poistaa luomasi API-avaimen Poista avain -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.
...