SOAP API on webservice API. Tämä tarkoittaa sitä, että API on internetissä saatavilla ja näkyvissä kaikille, jotka haluavat tarkastella sitä. API:ta käytetään kirjoittamalla ohjelmisto, joka yhdistyy siihen ja vuorovaikuttaa API:n kanssa. Severaan integroimiseksi tarvitaan API-avain. Ilman sitä, API:n käyttö ei ole mahdollista. Joten vaikka API itsessään on julkinen, sen käyttö on rajoitettu organisaatioille, joilla on Severan API-lisäosa käytössä ja jotka ovat luoneet ja ottaneet API avaimen käyttöön integraatio-ohjelmassa.
Lyhyesti integraatioon tarvittavat vaiheet ovat:
Määrittele tarpeet integroinnille. Tarvitaanko esimerkiksi työtuntien syöttämistä tai laskujen siirtoa?
Tarkista, onko SOAP API:ssä tarvittavia rajapintoja ja vaihtoehtoja integraatiota varten. Käytä API-dokumentaatiota yhdessä Severa ympäristön kanssa saadaksesi tarvittavat tiedot.
Jos integroidut toisen ohjelmiston kanssa, tarkista myös, että toisessa päässä on API tai jokin muu tapa halutulle vuorovaikutukselle.
Jos kaikki vaikuttaa hyvältä, luo ohjelmisto, joka yhdistyy API:hin ja suorittaa integraation. Usein tarvitaan palvelin, jossa integraatio pyörii. On myös suositeltavaa seurata ja lokittaa mahdolliset integraatiovirheet.
SOAP API on passiivinen, mikä tarkoittaa sitä, että integraatio-ohjelmiston täytyy kutsua API:a suorittaakseen toiminnon ja odottaa API:n vastausta nähdäkseen, oliko se onnistunut.
Klikkaa tästä lisätietoja ja ohjeita (Vain englanniksi).
API: n määrittäminen organisaatiollesi
Pystyäksesi integroitumaan Severaan, sinun täytyy ottaa käyttöön API Severa-organisaatiossasi.
Suosittelemme luomaan yhden API-käyttäjän Severaan, joka ei ole kyseisen organisaation työntekijä. Tämä johtuu kahdesta syystä:
Sitä tarvitaan antamaan API-avain käyttäjälle, jolla on laajat käyttöoikeudet Severaan, koska on tärkeää saada oikeat tiedot ulos ohjelmasta. Kaikki API:sta saatu data on rajoitettu käyttäjän pääsyoikeuksilla, jonka API-avain on käytössä.
Kun API-käyttäjä ei ole organisaation työntekijä, ei ole niin paljon tarvetta pitää kirjaa siitä, kenen käyttäjän API-avain on käytössä, ja mitkä ovat tämän käyttäjän käyttöoikeudet tai onko tämä käyttäjä edelleen yrityksen palveluksessa. Jotta integraatiot toimisivat tulee API-käyttäjän olla aktiivinen koko ajan, joten jos API-avain on luotu tietylle työntekijälle, integraatio lakkaa toimimasta, jos käyttäjä inaktivoidaan.
Kun API-käyttäjä on luotu ja API aktivoitu, käyttäjälle generoidaan API-avain. Tämä API-avain on käytössä integraatio-ohjelmistossa ja se tunnistaa API-kutsun tekijän ja käyttäjän organisaation, varmistaen että data palautetaan oikein.
Jos käyttäjälle uusitaan API-avain, tulee se päivittää ohjelmistoon, joka integroituu Severaan.