Mercury Public API Third Party Onboarding Guide

Overview

Mercury provides a Public API that enables approved Third Parties to build integrations with Mercury and, where applicable, access mutual customer data. While the Public API has primarily been built to support Third Party integrations, Mercury customers may also use the Public API directly for approved use cases, such as building bespoke or internal integrations.

All access to the Mercury Public API is subject to a formal approval and sign‑off process to ensure appropriate use, data protection, and security. A formal certification process is also required for third parties. 

If you are interested in using the Mercury Public API, the next steps depend on who you are:

• Mercury customers should contact their Mercury Customer Success Manager (CSM) to discuss their use case.
• Third Parties who are not Mercury customers should contact hello@wearemercury.com to initiate discussions around suitability and onboarding.

These initial discussions are required to:

• Understand the proposed use case
• Confirm whether the Public API is suitable
• Determine the appropriate access model and approvals
• Initiate the formal onboarding process

Access to the Mercury Public API and Developer Portal will only be granted once this assessment and sign‑off process has been completed.

Onboarding Overview

This Onboarding Guide for the Mercury Public API is intended to support approved Third Parties and customers who have already completed the initial review and approval process.

There are two main roles in the onboarding process:

• Firstly, Mercury will grant access and configure the required setup, including linking the Third Party or customer user to the relevant Dynamics User, enabling access to approved data.
• Secondly, the Third Party or customer will use the Developer Portal to manage their Subscriptions and Subscription Keys, which are required to make authenticated requests to the Mercury Public API.

The first part of this process will have already been completed by Mercury, allowing access to the Developer Portal and enabling the steps outlined below.

Process

This section describes the steps required after approval has been granted to set up an integration with Mercury using the Mercury Public API. The process allows the Third Party or customer to subscribe to the Mercury Public API and generate a Subscription Key, which is required when making requests.

Subscribe to the Mercury Public API product

Once access has been approved and the user has been invited to the Mercury Public API’s Developer Portal, they can configure a Subscription to the Mercury Public API. This will generate a Subscription Key that allows authenticated requests to be made.

Performed by: Third Party User or Customer User

1. You should have received an email inviting you to the Developer Portal.
   1.1 If an email invite hasn’t been received, go to the Developer Portal and use the Forgot your password? functionality via the Sign In page.
   Developer Portal: https://apim-uks-thirdpartyintegration-prod.developer.azure-api.net
   1.2 Once your password has been set, navigate back to the Developer Portal and proceed to Step 4.
2. Click the link in the email and you should be taken to the Developer Portal.
3. The Developer Portal website will open. Follow the instructions to reset your password.
4. Once reset, you will be redirected to the home page of the Developer Portal. Click Sign In in the top‑right corner of the screen.
5. Enter your new credentials and sign in.
6. Click Products in the top‑right corner of the screen.
7. Select Mercury Public API.
8. Under the heading Your Subscriptions, enter a subscription name and subscribe.
9. Enter a Subscription name (typically the name of your organisation).
10. Click Subscribe.
11. You will now have a valid subscription to the Mercury Public API.
12. Click Show next to the Primary Key and take a copy.

NOTE: This key must be provided in the subscription-key header when making authenticated requests to the Mercury Public API.

END