Approved integration owners access their Keys via the Iress API Key Portal, create their own OAuth secrets, can view active Xplan sites and supported capabilities etc.
Iress API keys can be connected to multiple Xplan sites but we support a single redirect uri. In practical terms therefore any one integration would likely be supported by two separate keys, one connecting to the third party production environment the other their development environments.
Once you have your API key you will need to pass authentication before you can use it. Often authentication is bundled together under the broader term ‘access’ but it is worth highlighting individually.
Iress API Keys use OAuth 2.0 (Authorisation Code Grant) as their preferred authentication mechanism.
Once initially established an Xplan session can be maintained for a maximum of one hour before the need to re-authenticate. However Iress also support a refresh process whereby a new session can be established programmatically - meaning after the initial connection there is no requirement for the physical user to re-authenticate.
HTTP Basic Authentication is also supported but discouraged due to the necessity to store user credentials.
More information about getting connected, with worked examples is available in the XXXX community.
