Explore LeanIX APIs and learn when to use each API.
Overview of Available APIs
LeanIX provides a suite of powerful APIs that enable you to interact with and manipulate data within the LeanIX platform. These APIs offer flexible and efficient ways to integrate with other systems, manage your workspace data, and create custom reports.
The following table provides an overview of available APIs.
| API | Description |
|---|---|
| REST APIs | REST APIs offer access to a wide range of resources, including the meta model, workspace settings, users, metrics, surveys, and more. These APIs are ideal for integration with systems that support RESTful interactions. You can explore and experiment with REST APIs using the OpenAPI Explorer, accessible from your workspace. |
| GraphQL API | The GraphQL API enables you to retrieve and update fact sheets and related data using GraphQL queries and mutations. You can use the built-in GraphiQL tool in the administration area of your workspace to interactively develop and test your queries and mutations. |
| Integration API | The Integration API supports integrations with external platforms. It uses our custom LeanIX Data Interchange Format (LDIF) to process data, simplifying the integration process and reducing complexity. This API is ideal for building integrations between LeanIX and other vendor systems. |
REST APIs
LeanIX REST APIs offer a versatile interface for interacting with a wide range of resources, including the meta model, workspace settings, users, metrics, surveys, and more. These APIs are designed for seamless integration with systems that support RESTful interactions.
To enhance your experience with LeanIX REST APIs, we provide the OpenAPI Explorer. This tool enables you to explore APIs, send requests, and view responses directly in your browser. To navigate to the OpenAPI Explorer from your workspace, in the user profile menu, select About LeanIX, then click Browse API.
GraphQL API
LeanIX chose GraphQL for managing fact sheets and related data due to its adaptability and efficiency in handling intricate data structures and relationships. Fact sheets in LeanIX often encompass complex models and relationships, which can be difficult to handle with traditional REST APIs. GraphQL presents a solution to this challenge.
Rather than dealing with fixed data structures, GraphQL enables clients to specify the exact data they need, significantly reducing the volume of data transferred over the network and enhancing performance. This is particularly beneficial when dealing with complex fact sheets, as it allows for more precise and efficient data retrieval.
Moreover, GraphQL's capability to fetch related data in a single request aids in managing the relational complexity of fact sheets. With traditional REST APIs, retrieving related data often necessitates multiple requests to the server. However, with GraphQL, you can retrieve all related data in a single query, making it a powerful tool for working with the interconnected data in fact sheets.
GraphQL enables you to query data on your fact sheets as well as mutate (create, update, or delete) data. In addition, GraphQL is used to create custom reports, specifically to pull data from the workspace and present it using charts and other graphics.
We provide GraphiQL, an interactive tool that streamlines interaction with the GraphQL API, providing an intuitive interface for workspace administrators to explore the GraphQL schema, experiment with queries and mutations, and validate them in real time. To navigate to the GraphiQL tool, in the administration area, select Developer Tools, then select GraphiQL. To learn more, see GraphiQL Tool.
Integration API
The Integration API is a powerful and flexible tool designed to streamline the integration process between LeanIX and other vendor systems. One of the key features of the API is that it uses the generic LeanIX Data Interchange Format (LDIF), which minimizes complexity and eliminates the need to map logic within the code. This enables developers to effectively use the API without needing an in-depth understanding of the LeanIX meta model. For more information, see LeanIX Data Interchange Format (LDIF).
The Integration API manages CRUD operations for any inbound data from other systems within LeanIX, significantly reducing complexity. It also allows for the definition of variables and exceptions and the use of JUEL expressions to extract or import only specific values.
Additional benefits of the Integration API include the encapsulation of LeanIX configuration in every connector, the capability to integrate even when the external system doesn't allow direct access, and flexible error handling. The API mitigates failure due to single or multiple data issues by disregarding data that doesn't meet the requirements.
The Integration API also supports the import and export of data from your workspace. This feature is particularly beneficial when the built-in functionality for importing or exporting doesn't align with your needs, such as when managing attributes on relations. The API also excels in handling more complex scenarios, for example, when the data from the source system is not in a clean state.