Litmuslogo

HomeUnlocking Seamless Integration: A Guide to Litmus API Portal for Litmus Edge and Litmus Edge Manager APIs.BlogUnlocking Seamless Integration: A Guide to Litmus API Portal for Litmus Edge and Litmus Edge Manager APIs.

Unlocking Seamless Integration: A Guide to Litmus API Portal for Litmus Edge and Litmus Edge Manager APIs.

Unlocking Seamless Integration: A Guide to Litmus API Portal for Litmus Edge and Litmus Edge Manager APIs.

By Parth Shah, Data Scientist at Litmus

Application Programming Interfaces (APIs) unlock the potential of enterprise solutions by enabling systems to interact seamlessly. This document provides an overview of the Litmus API Portal designed for Litmus Edge and Litmus Edge Manager, offering guidelines on how you can leverage it to enhance your development and integration workflows.

Check out this video for sample applications built using the Litmus API Portal.

Goal

Our aim is to facilitate seamless integration of Litmus Edge (LE) and Litmus Edge Manager (LEM) functionalities into custom applications by providing robust API support. This initiative caters to developers eager to craft personalized applications, automate workflows, design unique user interfaces, and more, without the constant need to navigate through the standard UI.

Limitations

Due to the inherent nature of API documentation, it is impractical to disclose every detail about LE/LEM, such as internal APIs, forthcoming updates, or deprecated features.

Proposed solution

To address these limitations, we plan to launch a version-specific API portal for LE and LEM. For instance, while versions LE 3.5.x and LE 3.11.x might share numerous APIs, differences will exist in terms of additions, deletions, or modifications. Version-specific documentation ensures users can maintain and update workflows when transitioning between software versions. Documentation for older versions will be accessible for about six months after a new stable version is released.

Expectations

The API portal will primarily feature APIs essential for sustained integration and development. Any attempt to use undocumented APIs—acquired through guesswork, reverse engineering, or similar methods—will not be supported by Litmus.

How to use the API portal

This document does not cover basic API concepts, such as naming conventions or the distinctions between POST and GET requests.

Getting Started

The portal currently offers a Postman collection, a choice that may evolve in the future. If you are a Postman user, you can download and experiment with this collection immediately.

  • To simplify interactions with multiple APIs, we utilize environment variables (e.g., LE URL, Edge API token, DeviceHub device names). We recommend setting these up in the environment variable tab to match your test environment.
  • Authorization requires an Edge API token, obtainable through the LE UI. Refer to our documentation for details.
  • Most APIs are ready-to-use with the configured environment variables. A small subset may require additional JSON bodies or query parameters. These exceptions are designed to be easily identifiable and adjustable to meet specific needs.
  • If Postman client is not your tool of choice, manually checking each API you want, copying the corresponding cURL command or Python requests code, C/GoLang code, etc., along with the request parameters and body should always work as expected too. Example scenario: you would like to use LE APIs to create a python application. Here, you want to bypass any API client apps, and just use the API in python’s ‘requests’ library – This scenario is totally within the boundaries of expectation for the API portal usage.

Conclusion

We encourage users to provide feedback for continual improvement of the API Portal. Your insights are invaluable to us.

By following the instructions laid out in this article, users can navigate and utilize the Litmus API Portal effectively, enhancing their development and integration capabilities with Litmus Edge and Litmus Edge Manager.

We are committed to making your Litmus API interactions as frictionless as possible. Get started with the Litmus API Portal today and start developing at the speed of innovation!

Subscribe To Our Newsletter

Get updates and learn from the best

ニュースレターを購読し、

最新情報を入手