Web Service API-avaimet

Web Service API-avainten hallinta

CRM-servicen API-avainten avulla voidaan sallia ja mahdollistaa ulkoisten palveluiden integroiminen CRM-järjestelmän kanssa. API-avainten hallinta tapahtuu kohdassa Asetukset → Webservice API avaimet.

API-avainten asetuksissa voidaan luoda uusia, poistaa vanhoja ja lukita olemassaolevia API-avaimia, sekä antaa avainkohtaisia oikeuksia webservice-metodeihin.

Uuden avaimen luominen

Uusi API-avain luodaan painamalla vasemmassa yläkulmassa olevaa Uusi API avain -painiketta. Uuden avaimen käyttötarkoitus määritetään valitsemalla avaimen tyyppi (ks. kuva alla). Tyypin voi valita joko valmiista vaihtoehdoista (esim. ”Outlook” CRM:n ja sähköpostin synkronoimikseksi tai ”ContactPortalv2” massapostiportaalin yhdistämiseksi CRM:ään) tai valitsemalla vaihtoehdon ”Custom”, jolloin pääkäyttäjä määrittelee avaimen oikeudet itse tallentamisen jälkeen.

Avaimelle annetaan myös kuvaus, jonka jälkeen avaimen voi tallentaa ja järjestelmä generoi itse avaimen. Avain on näkyvissä ja kopioitavissa API avain -sarakkeesta.

Kun avain on luotu, sen oikeuksien (vain ”Custom”-tyypin avaimilla) ja kuvauksen muokkaaminen, lukitseminen ja poistaminen tapahtuvat Toiminnot-sarakkeen toiminnoilla. Avaimen lukitseminen tarkoittaa, että avainta voi muokata tai sen voi poistaa vain sen lukinnut käyttäjä.

Jokaisella avaimella on myös aikaleima Viimeksi käytetty -sarakkeessa, joka näyttää ajankohdan, jolloin avainta on viimeksi käytetty rajapinnan kautta. Aikaleimojen seuraaminen ja tarpeettomien avaimien poistaminen edistävät CRM-järjestelmän tietoturvaa. Juuri luoduilla avaimilla leimaa ei vielä ole, sillä niitä ole vielä käytetty.

SOAP-rajapinta
REST-rajapinta
CRM-service CIWS-kirjasto
Tiedostokokojen rajoitukset CRM-servicessä
Web Service -rajapinnat
Combined Shape