Skip to content

Sample code to connect to Iress Xplan API when 2FA is enabled.

License

Notifications You must be signed in to change notification settings

iress/iress-xplan-api-examples

Repository files navigation

Build Status

Example Connecting to Iress Xplan RAPI and EDAI

A sample project to demonstrate how backend applications can use basic authentication with Iress Xplan Resourceful API and EDAI. This also includes sample code that uses Two Factor Authentication (2FA).

Note: 2FA for the user must use the Software Token method.

Pre-requisites

Please see Pipfile for the Python dependencies.

Usage

To view the current usage/help please run the below command:

$ python3 ./run.py -h

Examples

RAPI using 2FA
./run.py -b https://dev.xplan.iress.com.au -u testuser -p ASDDsf3sdsf2 -o HTHHH72MQ7CBVX3SU25YRKQO6OAI36TD -i FPj9cymketaHXunJE3E3 -tfa -api
EDAI using 2FA
./run.py -b https://dev.xplan.iress.com.au -u testuser -p ASDDsf3sdsf2 -o HTHHH72MQ7CBVX3SU25YRKQO6OAI36TD -i FPj9cymketaHXunJE3E3 -tfa -edai

Note:

  • If you don't specify a password using the -p option the script will prompt for the password
  • If you don't specify an OTP Secret using the -o option the script will prompt for the secret

Sample result of the above script:

[
    {
        "bookmark": "eyJpZCI6MTI1OX0=",
        "id": 1259,
        "entity_name": "Portfolio Superfund"
    },
    {
        "bookmark": "eyJpZCI6MTQwNn0=",
        "id": 1406,
        "entity_name": "Portfolio Company Pty Ltd"
    },
    {
        "bookmark": "eyJpZCI6MTQwN30=",
        "id": 1407,
        "entity_name": "Portfolio Trust"
    }
]

2FA Technical Details

Please see

EDAI Authentication Using RAPI

Please see

Licence

MIT License (See the included Licence file for more information).

About

Sample code to connect to Iress Xplan API when 2FA is enabled.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published