Skip to main content

API Integration - Generate API Key

Learn how to generate an API Keyin AdviserLogic for use with external integrations

Maria Iglesias - Content Lead avatar
Written by Maria Iglesias - Content Lead
Updated over 2 weeks ago

Click on images to expand



โ€‹Overview

API keys are essential for integrating AdviserLogic with other platforms, allowing seamless data exchange and automation of tasks. If you're looking to generate an API key within AdviserLogic, follow the below steps.


โ€‹Access

To access the API Key and password generator, navigate to Tools > Adviser Tools > API Key > Generate API Secret Key

๐Ÿ“ŒNote


If you cannot see this option in your account please contact AdviserLogic Support


โ€‹
โ€‹Create a New API Key

In the API Management interface, you will first see an existing API Key and password with a Re-Generate button on the left side of the screen. On the right side, you'll find a list of any previously generated API keys. If no keys have been generated yet, this section will be blank, and the button will instead say Generate.


โ€‹
To create a new API key, choose the Generate or Re-Generate button.
โ€‹

โš ๏ธA warning confirmation message will open if you have existing keys, asking you to confirm the action because generating a new key will expire any existing keys. If you have no existing keys no warning will show.


โ€‹
AdviserLogic will produce a unique API Key and Password which will expire 1 year from the date it was generated.
โ€‹
โ€‹

๐Ÿ“ŒNote


This Key and Password will remain in the left section to be copied and pasted as required.


โ€‹
โ€‹Key History

Key history will show on the right side of the screen, along with the time and date of generation, their status will show in the top right corner of the field.

๐Ÿ’กTip
โ€‹
It is advisable to regularly rotate your API code for security reasons and record where they have been used


โ€‹
The current Active Key will show at the top of the list - This relates to the Key and Password displayed in the left section and used to connect with 3rd party software.
โ€‹
โ€‹
By following these steps, you can efficiently generate and manage API keys in AdviserLogic, enabling secure and seamless integration with other systems.
โ€‹
โ€‹
โ€‹

Did this answer your question?