📘

New here?

If you're not familiar with the different Consumer Journey APIs, we recommend reading our introduction to the APIs we offer.

🚧

Authentication

Our Dashboard endpoint requires an Authentication Token in the request. Click here to find out how to generate it.

The Entry Point API is used to transition a user from a native (usually in-app) experience to a web view. The web view is operated by Mention Me and displays the same journey displayed on the web.

Benefits of using our API for web links

• Recommended for both web-based and native apps, it's easy and doesn't require too much custom development
• It allows the marketing team to control the content and even enable or disable individual touch points as and when required, directly via the Mention Me platform
• It allows AB testing of customer journeys via the Mention Me platform directly to continuously optimise the programme

Advice for Android Developers

Android has multiple ways of displaying WebViews. There is an "embedded" web view, and a "in app browsing" web view which a user can open in Chrome from your app.

The "embedded" web view is a limited browser and as such does not support the navigator.share API. This powers the "share via any app on your phone" method we call "native share". This functionality does not work in the embedded view. This is a known issue in Chromium. The "share via any app" method is a much nicer experience for users, and allows them to share on apps Mention Me might not directly support today.

We recommend you use the "in app browsing" approach instead. The experience is better for the user, and allows you to use our message capture functionality to see how your customers are talking about your brand.

You can read about these two methods on Android's documentation:

• Embedded
• In app browsing

How to use the Entry Point API

Step 1

Add links/buttons at various key touch points in your app for the following purposes:

1. Referrer promotion
2. Referee integration for name sharing
3. Order tracking
4. Referrer dashboard

Step 2

Use our Entry Point API to get the URLs and copy for the Calls to Action for these various buttons and links.

❗️

Important

Use the url demo.mention-me.com in your API endpoints when developing and testing.

Switch to the live url mention-me.com when you deploy your integration live.

Frequently asked questions

I have a web-based app, can I use Javascript tags to integrate Mention Me?

If you have a web-based app and can use Javascript tags within it, then that can be a suitable option. Follow our web integration guide.

I would like to build the referral journey natively into my app, do you have an API for that?

Yes, we have a publicly accessible consumer API analogous to our Javascript tag implementation which lets you tell us about various events from your apps.

We provide back the copy to allow you to build the journey. This enables you to build an entire referral journey natively into your app. We recommend proceeding with this integration as a phase 2, once you’re happy with how the programme performs. See further instructions for our Consumer API.

Can I integrate the programme in different languages in my app using the API?

Yes, all the integration options allow you to use a locale parameter which can be passed to Mention Me to trigger a specific campaign for the user's language/region and currency. Your locales need to be configured via the Mention Me platform. Your Onboarding Project Manager can help with this.