Introduktion

Efecte Service Management-verktyget (ESM) inkluderar ett öppet API som gör det möjligt att ansluta till alla externa system. Denna anslutning möjliggörs genom ett REST API , vilket underlättar modern integration med olika externa applikationer. Byggt på REST principer erbjuder detta API ett mångsidigt och effektivt sätt att hantera data inom plattformen.

Efectes REST API har omfattande funktioner som syftar till att stödja utvecklare, göra integrationer smidigare och förbättra hur olika system fungerar tillsammans.

Organisationer, oavsett storlek, arbetar med många sammankopplade system och processer. Dessa system kan finnas inom en enda avdelning eller omfatta flera avdelningar. Genom att integrera dessa viktiga system kan organisationer avsevärt minska det manuella arbetet. Efectes REST API hjälper till med detta genom att erbjuda ett säkert och lättanvänt gränssnitt för utvecklare.

För att aktivera REST API et i valfri Efecte-miljö, se till att Efecte Service Management-verktyget (ESM) är uppdaterat till version 2021.4 eller senare. Aktivering kräver att du får en REST API licens från Efecte, vilket aktiverar systemets Efecte External API modul. Dessutom är det nödvändigt att konfigurera en teknisk (lokal) användare och definiera deras roll för att hantera åtkomst.

Det är viktigt att notera att REST API inte täcker administrativa funktioner eller datamodellhantering inom Efecte-systemet. För en detaljerad översikt över vad REST API erbjuder, vänligen besök vår Efecte REST API dokumentation.

Rekommenderade scenarier

REST API är användbart i många situationer där du behöver skicka data till ESM eller ta emot data från ESM. Det är det primära valet för Efectes kunder och partners när de skapar kopplingar till ESM. Vanliga användningsområden inkluderar att hämta tillgångs- och konfigurationsinformation från lagerverktyg, ansluta till andra ITSM- eller ärendeplattformar, länka till ERP-system, synkronisera med HR-system och ansluta till rapporterings- och analysverktyg.

Dokumentation

REST API dokumentationen finns via länkarna nedan.

• Översikt över REST API
• Beskrivning av REST API gränssnittet

Utöver den standarddokumentation som tillhandahålls erbjuder Efecte även onlinedokumentation som är tillgänglig via Swagger , ett praktiskt verktyg för att interagera med API och visa detaljerad dokumentation. Denna onlineresurs är lättillgänglig i alla miljöer som har en giltig REST - API licens. Du kan komma åt Swagger -gränssnittet genom att navigera till din bas-URL följt av /rest-api/itsm/v1/docs/swagger/index.html (till exempel https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html ).

Swagger skapar denna dokumentation i enlighet med Open API 3.0-specifikationen. Dessutom kan dokumentationen laddas ner från användargränssnittet på din bas-URL, följt av /rest-api/itsm/v1/docs/openapi.json . Efter nedladdningen kan dokumentationen importeras till olika integrations- och testverktyg, till exempel Postman, för att underlätta effektivare API utforskning och testning.