Johdanto

Efecte Service Management -työkalu (ESM) sisältää avoimen API , jonka avulla se voi muodostaa yhteyden mihin tahansa ulkoiseen järjestelmään. Tämä yhteys on mahdollista REST API kautta, mikä helpottaa modernia integrointia erilaisten ulkoisten sovellusten kanssa. REST -periaatteille rakennettu API tarjoaa monipuolisen ja tehokkaan tavan käsitellä dataa alustan sisällä.

Efecte REST API sisältää kattavia ominaisuuksia, jotka on tarkoitettu tukemaan kehittäjiä, sujuvoittamaan integraatioita ja parantamaan eri järjestelmien yhteistyötä.

Organisaatiot koosta riippumatta toimivat lukuisten toisiinsa liittyvien järjestelmien ja prosessien kanssa. Nämä järjestelmät voivat sijaita yhden osaston sisällä tai ulottua useiden osastojen alueelle. Integroimalla nämä olennaiset järjestelmät organisaatiot voivat merkittävästi vähentää manuaalista työtä. Efecte REST API auttaa tässä pyrkimyksessä tarjoamalla kehittäjille turvallisen ja helppokäyttöisen käyttöliittymän.

Aktivoidaksesi REST API missä tahansa Efecte-ympäristössä, varmista, että Efecte Service Management -työkalu (ESM) on päivitetty versioon 2021.4 tai uudempaan. Aktivointi edellyttää REST API -lisenssin hankkimista Efecteltä ja järjestelmän Efecte External API -moduulin käyttöönottoa. Lisäksi teknisen (paikallisen) käyttäjän luominen ja hänen roolinsa määrittäminen ovat välttämättömiä vaiheita käyttöoikeuksien hallitsemiseksi.

On tärkeää huomata, että REST API ei kata Efecte-järjestelmän hallinnollisia toimintoja tai tietomallien hallintaa. Yksityiskohtaisen yleiskatsauksen REST API tarjoamista ominaisuuksista löydät Efecte REST API -dokumentaatiostamme.

Suositellut skenaariot

REST API on hyödyllinen monissa tilanteissa, joissa sinun on lähetettävä tietoja ESM:ään tai vastaanotettava tietoja ESM:ltä. Se on ensisijainen valinta Efecten asiakkaille ja kumppaneille luotaessa yhteyksiä ESM:ään. Yleisiä käyttötarkoituksia ovat resurssien ja konfiguraatiotietojen tuominen varastotyökaluista, yhteyden muodostaminen muihin ITSM- tai tiketöintialustoihin, linkittäminen ERP-järjestelmiin, synkronointi HR-järjestelmien kanssa sekä yhteyden muodostaminen raportointi- ja analytiikkatyökaluihin.

Dokumentaatio

REST API -dokumentaatio löytyy alla olevista linkeistä.

• REST API yleiskatsaus
• REST API -rajapinnan kuvaus

Vakiodokumentaation lisäksi Efecte tarjoaa myös verkkodokumentaatiota Swagger kautta. Swagger on käytännöllinen työkalu API kanssa vuorovaikutukseen ja yksityiskohtaisen dokumentaation tarkasteluun. Tämä verkkoresurssi on helposti saatavilla kaikissa ympäristöissä, joissa on voimassa oleva REST - API lisenssi. Pääset Swagger -käyttöliittymään siirtymällä perus-URL-osoitteeseesi ja sen perään /rest-api/itsm/v1/docs/swagger/index.html (esimerkiksi https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html ).

Swagger luo tämän dokumentaation Open API 3.0 -spesifikaation mukaisesti. Lisäksi dokumentaatio voidaan ladata käyttöliittymästä osoitteesta, jonka perään tulee /rest-api/itsm/v1/docs/openapi.json . Lataamisen jälkeen dokumentaatio voidaan tuoda erilaisiin integrointi- ja testaustyökaluihin, kuten Postmaniin, mikä tehostaa API tutkimusta ja -testausta.