LEMONEDGE Documentation

Welcome to the LemonEdge API Documentation.

This API guide is aimed at developers and advanced users of the LemonEdge platform. For general help documentation on usability, and customisation see our user guide along with our beginner walkthroughs here.

Note

The LemonEdge API is built from the ground up as a modern, fast, and intuitive API to support you building entities, algorithms, and integrating them with the platform. Over 60% of LemonEdge itself was built using our own API. All the standing data, data integration, reporting tools and even the financial services engine was all built 80% quicker utilising our own API and automatically benefiting from the Auditing, Permissions, Reporting Tools, Canvases and much more provided by the platform.

This is why we're confident in saying you can leverage these benefits too!

Articles

Refer to our Articles for a complete list of development walkthroughs.

Our articles cover in depth walkthroughs of how to achieve any task you would like on the LemonEdge platform using our API.

Caution

These articles are aimed at developers, and are all written in c# (though you can use any .net language you wish) for you to walkthrough how to achieve specific aims on the platform.

Documentation

Refer to our API Documentation for more detailed information on the API.

The API documentation supports the following 3 LemonEdge dlls:

  1. Utils.dll This provides common helper functions throughout the platform.
  2. API.dll This is the core API interfaces for the entire platform. This is broken into two main areas:
    1. Design: Provides all the functionality for designing your entities on the platform, and interacting with the system entities such as the transaction engine. This accelerates about 80% of typical development by the system automatically taking care of database upgrades, tables, functions, web service, etc.
    2. Context: Provides the ability to query, insert, update, and delete all entities in the system including any custom created ones. These contexts can be used to create custom algorithms which seamlessly work with LemonEdge and without requiring any extra work can run locally, or on a task service, or in canvases, etc.
  3. ClientCore.dll Any UI code is automatically transformed by the platform to seamlessly work in our universal console application, windows app, web site version, and other applications. This again reduces around 80% of the typical development required around creating user interfaces for your data structures.
    1. UI: This provides all the common functionality for creating views, grids, commands and custom layouts in the LemonEdge platform.

All of the above can be created using our Auto-Code Designers which allow you to design these solutions from within the application itself. If you get to a point where the designer is constraining what you need to achieve, you can export the design to actual c# code. You can then enhance the code to achieve 100% of your design goals and import the dll back into the platform as an AddIn. This greatly increases the users of the system who are capable of creating a solution using either our designers or any .Net code.