Kun on tarve siirtää tietoa Neptonin ja toisen järjestelmän välillä, Nepton API -sovellusliittymä on hyvä vaihtoehto perinteiselle SFTP-liittymälle. Integraatiot voidaan siis toteuttaa API:n kautta.
Pyytävä järjestelmä voi tehdä palvelupyyntöjä Nepton API:lle milloin tahansa. Se, mikä on pyytävä järjestelmä, on asiakkaan päätettävissä ja se voi olla kolmannen osapuolen toteutus. API-kutsut voidaan luoda erilaisten sovellusten kautta tai esimerkiksi asiakkaan palvelimella ajettavien skriptien avulla. Joka tapauksessa, API-kutsujen toteutustapa riippuu asiakkaasta. Tämä ja muut API-aiheiset artikkelit auttavat asiakkaan tai kolmannen osapuolen rajapinnoista vastaavia henkilöitä ottamaan käyttöön API-toteutuksen.
Käytännössä API-sovellusliittymää hyödynnetään mm. projektien tai tapahtumien tuonnissa Neptoniin, jolloin lähettävään järjestelmään tehtävät lisäykset tai muutokset päivittyvät reaaliajassa Neptoniin.
Neptonissa on API sovellusliittymälle 2 eri endpointtia, jonne kutsuja voidaan tehdä. Toisessa endpointissa ovat Henkilötietojen sovellusliittymät
- Henkilöstö-, työsuhde- ja muut henkilöihin liittyvät kentät
ja toisessa endpointissa Työajan toiminnot, eli
- Poissaolot
- Työaikakirjaukset, jotka ovat tapahtumia palvelussa
- Projektit, kustannuspaikat ja työmääräykset, jotka ovat työn kohdennuksia tai projekteja palvelussa
API liittymän käyttöönotto
- Työaikatapahtumien, poissaolojen tai projektien sovellusliittymän käyttöön tarvitaan CustomerId-tunnus, jonka saa Neptonin yhteyshenkilöltä tai asiakaspalvelusta. Lisää työajan API:ssa tunnistautumiseen täältä.
- Henkilötietojen API vaatii autentikoitumiseen DeploymentId- ja Webservicepassword-tiedot, jotka saa Neptonin yhteyshenkilöltä tai asiakaspalvelusta. Lisätietoja Henkilötietojen API -artikkelista.
- API-kutsut todennetaan. Todentaminen edellyttää kirjautumistietoja ja muutokset tietoihin kirjataan lokiin tämän käyttäjän suorittamana. Jokaiselle sovellusliittymää käyttävälle ratkaisulle tulee hyvän tietoturvan takaamiseksi perustaa oma henkilö eli käyttäjätunnus. Luomalla yksilölliset käyttäjätunnukset, saadaan myös lokeihin tiedot, mitä käyttäjätunnusta ja mitä API-toteutusta on käytetty missäkin API-kutsuissa. Näitä käyttäjätunnuksia ei käytetä mihinkään muuhun tarkoitukseen kuin API-sovellusliittymien käyttöön. Hyvän tietoturvan takaamiseksi on suositeltavaa myöntää vain tarvittavat Neptonin roolit käyttäjätunnukselle, jota käytetään API-todennuksessa. Esimerkiksi jos sovellusliittymän toteutus ei käytä HR-tietoja, käyttäjätunnukselle tulee antaa rooli pienimmillä oikeuksilla HR-tietojen saamiseksi.
API liittymän käyttöönotto aineiston vientiin
Neptonista mm. projektien tai tapahtumien viennissä tarvitaan edellä mainittujen määritysten lisäksi sääntöjoukkojen poimintasäännöt, joiden perusteella määriteltyä sisältöä viedään toiseen palveluun.
API-sovellusliittymän käyttö sisältyy kaikkiin Neptonin palvelutasoihin.