Generating an API Key in AdviceOS

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

      

If 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



 




    • Related Articles

    • Colonial First State FirstChoice Application Integration

      Please note: Your practice will need an AdviceOS API key in order to set up the application integration with Colonial First State. Please complete the API Agreement and email it to info@midwinter.com.au, in order to set this up if you don’t have one ...

    • Moneysoft CRM

      We have included attached a user guide that runs through the set-up process in five short easy steps in order to integrate Moneysoft CRM into your AdviceOS. If you need further information you can visit the Moneysoft website here or alternatively ...

    • MyProsperity

      MyProsperity is a leading client portal solution for accountants and advisers. We have included the Integration User Guide, which has been attached at the bottom of this page. For further information on the integration of MyProsperity to AdviceOS you ...

    • Coming Soon E- Signature

      E-Signature Functionality – Integrating Docusign to AdviceOS Midwinter allows a business to integrate their existing Docusign account into AdviceOS, providing users with the ability to send and receive documents with eSignature functionality. This ...

    • Inherit Australia

      We are pleased to announce that we have an active API integration available with Inherit Australia, an estate planning platform and marketplace to help Advisers and Accountants navigate your clients' estate planning needs. To set up your Midwinter ...