Get to know Mantle

Our getting started guide will help you get to know the key ingredients behind the Mantle magic quickly.

What you'll build

By following these guides, you'll learn how to:

Set up secure API access to Mantle
Install and initialize the Mantle client library
Identify a customer to Mantle
Retrieve customer data from Mantle

Additional guides will then show you how to:

Track customer behavior with usage events
Manage subscriptions and billing
Surface Mantle data in your frontend

Prerequisites

Before you begin, you'll need:

A Shopify Partner account connected to your Mantle account
A Shopify development store for testing
Basic familiarity with REST APIs and JavaScript

The Mantle App API

This integration uses Mantle's App API, which is designed specifically for app developers to leverage Mantle features with their apps. It's distinct from the Core API, made for creating Mantle Extensions.

Good news! Mantle is free for apps generating less than $5,000 in Monthly Tracked Revenue (MTR), making it perfect for new and growing apps.

Quick start path

Our getting started section is designed to get you up and running with the basics in about 15 minutes:

Generate credentials - Get your API key and configure your environment
Set up MantleClient - Install and configure our helper library
Identify your first customer - Connect your first customer with Mantle
Make your first API call - Retrieve customer data

After completing these steps, you'll have the foundation needed to start using Mantle's features in your app.

Ready to begin?

Start with generating your credentials to take your first step with Mantle. Our guides include working code examples and clear explanations to help you move quickly.

Need help along the way? Join the Mantle Discord - we're here along with the whole community to ensure your integration is successful!