Contents
1. Introduction
2. Process
2.1 Subscribe to the Mercury Public API product
1. Introduction
The Onboarding Guide for the Mercury Public API is designed to help get Third Parties in a position where they can integrate with Mercury using the Mercury Public API.
There are two main roles in the onboarding process:
-
Firstly, Mercury will give access to the Third Party and set up up the link between the Third Party and the Dynamics User to give access to Dynamics.
-
Secondly, the Third Party will use the Developer Portal to manage their Subscriptions and Subscription Keys to be able to make requests to the Mercury Public API.
The first part will have already been configured, ready for the Third Party to use the Developer Portal and follow the process outlined below.
2. Process
This is to set up the integration with Mercury allowing access to use the Mercury Public API. The process will allow the Third Party to subscribe to the Mercury Public API and generate a Subscription Key to use when making requests to the Mercury Public API.
2.1 Subscribe to the Mercury Public API product
Now that the Third Party has been given access to the Mercury Public API’s Developer Portal, the Third Party User can go about configuring a Subscription to the Mercury Public API. This will generate a Subscription Key that will allow for authenticated requests to be made to the Mercury Public API.
Performed by: Third Party User
1. You should have received an email inviting you to the Developer Portal.
1.1 If an email invite hasn't been received, you'll need to go to the Developer Portal and use the Forgot your password? functionality via the Sign In page.
Link to Developer Portal: https://apim-uks-thirdpartyintegration-prod.developer.azure-api.net
1.2 Once your password has been set, navigate back 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 the Sign In button in the top right of the screen.
5. Enter your new credentials and sign in.
6. Click the Products button in the top right of the screen.
7. Click on Mercury Public API.
8. Under the heading Your Subscriptions there is a form for you to enter a subscription name and subscribe:
9. Enter a Subscription name that is the name of your organisation.
10. Click Subscribe.
11. You will now have a valid subscription to the Mercury Public API.
12. Click the Show button next to the Primary Key and take a copy. This is what you will use to make authenticated requests to the Mercury Public API, by providing the value in the subscription-key header.