Welcome to the Mention Me Developer portal. Here you'll find all the information you need to integrate with Mention Me via our APIs.

Audience

This guide is designed for developers, integrators, and anyone looking to connect and interact with our APIs. It is designed for advanced integration with Mention Me that goes beyond the capabilities offered by the Javascript tags.

📘

Geeks ahoy!

Some technical knowledge about APIs will be useful when following this guide. If you need technical support, reach out to our support team for help.

Our APIs

We have several APIs you can use. Each one is designed for a specific set of use cases:

🚧

Authentication

Our Entry Point API or Consumer API do not require API Keys but instead use an Authentication Token in the request.

---

Merchant API

The Merchant API is for interacting with the Mention Me platform, e.g. configuration, customers and data.

You can use this API to retrieve customer data and to inform Mention Me of customer actions.

The Merchant API requires authentication 🔐

---

Consumer Journey APIs

For displaying a user experience to your customers, you can use one of the following methods:

Javascript Tags

Our Javascript Tags are the most common method for displaying the customer journeys with Mention Me.

They are the easiest to get started with, and deliver the best Mention Me experience.

Speak to our support team to obtain custom instructions for your customer journey.

Entry Point API

The Entry Point API is best for clients wishing to display the Mention Me consumer journey inside their mobile applications.

It can be used to generate a webview in-app, and can be triggered from native components (e.g. links, navigation or banners) within your app.

It is best for clients who want customers to have a native experience, but don't wish to build the entire journey from scratch.

Consumer API

🚧

Beware!

The Consumer API is for advanced customers only. We strongly recommend you have built and tested your referral program using the Javascript tags before embarking on a full custom build.

Experimentation with the Consumer API requires significantly more work.

The Consumer API is for clients wishing to build the Customer experience from scratch.

Mention Me can provide "building blocks" of text and content for you to build your own experience with.

We'll handle the referral backend, while you can build the UI.

---

📘

Need help choosing?

Speak to our support team to discuss your requirements.