Mantle Core API and Mantle Extensions
Looking to get started?
Kick off the process: Become an Extension developer
Using the Mantle Core API
Mantle’s Core API and associated developer tools provide the opportunity to extend Mantle’s functionality in powerful and flexible ways.
Mantle Extensions will also be available via the Mantle App Store (Coming Soon).
The purpose of this documentation is to equip you with everything you need to begin building Mantle extensions for yourself and others, from API documentation to best practices.
It will also cover the early, work-in-progress requirements to help you prepare for listing your extension in the App Store. We will be working closely with all early extension developers to give guidance, get feedback, and make sure we’re building the right tools for Mantle users.
As of December 2024 this documentation is a work in progress, and the Core API and associated tools are rapidly evolving.
Mantle Extensions
Mantle extensions are classified along two axis: Embedded vs. Non-embedded, and Private vs. Public.
Embedded vs. Non-Embedded Extensions
Embedded Extensions are the preferred choice for building Mantle extensions. They offer an embedded experience directly inside Mantle so that users can engage with your extension without breaking their existing workflows. Embedded extensions:
- Offer the ability to integrate in to other areas of Mantle through Custom Actions
- Blend in to Mantle’s product through the use of Litho, our design library
- Are easy to build using Mantle App Bridge to authenticate their requests and the postMessage API to communicate with Mantle
Non-Embedded Extensions allow you to use the Core API to read and write data to Mantle using the Core API in cases where an embedded experience is impossible or would offer a worse user experience. Non-embedded extensions:
- Are a good solution for integrating Mantle with established platforms with their own in-depth workflows
- Don’t have access to Mantle App Bridge and so handle authentication through HMAC parameters.
Public vs. Private Extensions
Upon the public release of Mantle Extensions, extensions will also be divided in to Public and Private extensions.
Private extensions are ideal for developers who need to pull Mantle data into their own servers for cross-referencing or importing into other systems. By leveraging the Core API, you can create solutions that interact with Mantle's data and services, allowing you to integrate Mantle data into your existing infrastructure or custom functionality you have built for yourself.
Public extensions are destined for the Mantle App Store, releasing soon. If you’re an existing platform, or have identified ways Mantle could be extended in ways that would benefit others – this is the path for you. You can submit your interest here and we’ll be in touch.