Introduction

The Efecte Service Management tool (ESM) includes an open API that allows it to connect with any external system. This connection is made possible through a REST API, which facilitates modern integration with various external applications. Built on RESTful principles, this API offers a versatile and effective way to handle data within the platform. 

The Efecte REST API comes with comprehensive features aimed at supporting developers, making integrations smoother, and improving how different systems work together.

Organizations, regardless of their size, operate with numerous interconnected systems and processes. These systems may exist within a single department or span across multiple ones. By integrating these essential systems, organizations can significantly reduce manual work. The Efecte REST API aids in this endeavor by offering a secure and easy-to-use interface for developers.

To activate the REST API in any Efecte environment, ensure that the Efecte Service Management tool (ESM) is updated to version 2021.4 or later. Activation requires obtaining an REST API license from Efecte, enabling your system's Efecte External API module. Additionally, setting up a technical (local) user and defining their role are necessary steps for managing access.

It's important to note that the REST API does not cover administrative functions or data model management within the Efecte system. For a detailed overview of what the REST API offers, please visit our Efecte REST API Documentation.

Recommended Scenarios

The REST API is useful in many situations where you need to send data to ESM or receive data from ESM. It is the primary choice for Efecte customers and partners when creating connections with ESM. Common uses involve bringing in asset and configuration details from inventory tools, connecting with other ITSM or ticketing platforms, linking with ERP systems, syncing with HR systems, and connecting with reporting and analytics tools.

Documentation

The REST API documentation can be found via the links below.  

• REST API Overview
• REST API Interface Description

In addition to the standard documentation provided, Efecte also offers online documentation accessible through Swagger, a practical tool for interacting with the API and viewing detailed documentation. This online resource is readily available in every environment that has a valid REST-API license. You can access the Swagger UI by navigating to your base URL followed by /rest-api/itsm/v1/docs/swagger/index.html (for example, https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html).

Swagger creates this documentation in line with the OpenAPI 3.0 specification. Furthermore, this documentation can be downloaded from the UI at your base URL, followed by /rest-api/itsm/v1/docs/openapi.json. After downloading, the documentation can be imported into various integration and testing tools, such as Postman, to assist in more efficient API exploration and testing.