Generating an API Key in AdviceOS

Introduction

Midwinter’s API provides you the ability to integrate AdviceOS and other third-party providers. This can help your Practice streamline the transfer of information across these platforms. In order to set up one of these integrations, you need to generate an API Key in AdviceOS.

Note: Before you can generate an API Key in AdviceOS you need to ensure you have met the required authorisations, with the appropriate agreement signed and in place with the third party. Please review the article specific to the integration you are interested in, or speak to our support team for further information.

How to generate an API Key

The steps to generate an API Key are as follows:

1. Navigate to the Mega Menu.

2. Go to Settings.

3. Under the External Systems heading there should be an API Config> Generate API Key button available

f this button is not available, or you do not meet the appropriate permissions required, please reach out to our support team.

4. Set the level to ‘Practice’.

5. Specify the environment is ‘Production’.

6. Click ‘Generate API Key’.

7. In the ‘API Key’ pop-up click ‘Copy API key to clipboard’.

8. Click ‘Ok’ to close the pop-up.

9. Follow the instructions from the Integration Partner and ‘paste’ the key into the specified field

Important: DO NOT save a copy of the API Key, you will not need this again

Important: DO NOT share the API Key, once this has been added to the integrating software nothing else needs to be done