API-avaimet

API-avain on tarkoitettu rajapintaintegraatioihin. API-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äytön tarvittaessa..

API-avainten hallinta on yritystiedoissa API-avaimet -välilehdellä. Api-avain luodaan suoraan yritykseen, jossa sitä käytetään. Voit luoda useita API-avaimia esimerkiksi erilaisia integraatioita varten. Api-avainta luodessa avain näytetään vain kerran, joten kopioi luotu API-avain ja tallenna se heti turvalliseen paikkaan.

Huomaa, että myös SOAP- ja REST-rajapintojen käyttäminen vaatii käyttäjän tunnistamisen.

Luo rajapintoja varten paikallinen tili ja lisää käyttäjä myös henkilörekisteriin samalla sähköpostiosoitteella, ja anna käyttäjälle tarvittavat oikeudet.
Rajapintojen käyttäminen edellyttää IWS_LOG (Webservice-rajapinnat) -lisenssiä ja mahdollisia muitakin käyttöoikeuksia integraatiotarpeesta riippuen.
Käyttäjätiedon lisäksi rajapinta tarvitsee API-avaimen.

API-avaimen luonti

Integraattori eli kolmas osapuoli, joka tekee integroinnin Lemonsoftin rajapinnan avulla, tarvitsee API-avaimen. Avaimen luonti tapahtuu yritystietojen API-avaimet -välilehdellä Luo uusi avain -toiminnolla. Anna avaimelle kuvaava selite, esimerkiksi ’Kauppapaikka’ ja vahvista Lisää avain -toiminnolla. Kopioi luodun API-avaimen arvo talteen ja toimita avain Integraattorille.

Kuva: API-avaimen luonnissa API-avaimen arvo näytetään vain, joten tallenna luotu avain heti talteen.

API-avaimen poistaminen

Voit poistaa luomasi API-avaimen Poista avain -toiminnolla. API-avaimen poiston jälkeen sen avulla tehdyt integroinnit eivät enää toimi.

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 ennen kuin rajapinta taas on käytössä.