Home - accountsIQ/API-Wiki GitHub Wiki
This document presents the exposed API via the AccountsIQ web services.
Overview
AccountsIQ exposes web services for a greater flexibility of interaction with third-party systems.
These web services currently cover the main data entities of the system and will be extended over time to cover all data entities.
Integrator Partners
Please read and acknowledge by email to [email protected] the Terms of use before using the provided API.
The integrator partner key is a sensitive piece of information and must be treated as such. The integrator is responsible for the use of his key. Ensure it is kept secure and not accessible via reverse engineering or any other method at any time.
[!NOTE]
Version 1.1 is only supported for existing integrations, therefore new Partner Keys will not be distributed. It will no longer be used for any newly created integrations. To set up new integrations, please refer to the documentation for Version 2.0.Creating an Integrations Application and Inviting a Developer to the Developer Portal
Authentication
Our SOAP API supports two versions of authentication:
- Version 2.0 – This is the current standard and should be used for all new integrations.
- Version 1.1 – This legacy version is only supported for existing integrations and will not be used for new integrations. Documentation still available, see below
Setting Up Authentication for Version 2.0
To begin, an admin within the AccountsIQ system (for a Practice) must create an Integration Application.
During the setup process, the admin will:
- Assign a name to the application.
- Provide a developer email address.
- Specify which entities the Integration Application will have access to.
- Scope of the Integration Application
Learn how to create an Integration Application and invite a developer to the Developer Portal
Once the application is created, the developer will receive an invitation to the Developer Portal via email.
Through the portal, developers can :
- Verify the Integration Application
- Access the credentials for get tokens
- WSDL connection details
Learn how to use the Developer Portal and the new API Authentication Endpoints
Authorisation
The authorisation is handled via the Entities and scopes that are assigned when creating the Integration Application.
Setting Up Authentication for Version 1.1
Please see Authentication 1.1
Authorisation
The authorisation is the authorisation in place in the AccountsIQ system: the user only has the rights to perform operations he/she can perform from the front-end.
How to use the Authentication in Code for Version 2.0 and 1.1
Life cycle
The AccountsIQ system evolves constantly and so does its exposed web services interface. To avoid incompatibilities with our integrator partner applications, we provide a list of versioned web services. When an update is made to the AccountsIQ system that mandates a change in the API, we provide a new web service with the next version number while keeping the previous API of the previous web service in a working state. The previous web service version is maintained for a duration of 3 months.
When a new version of the web services is made available, a mail is sent to all integrator partners requiring them to update their application within 3 months. After three months, the previous web services version is retired.
A staging environment is available for integration testing, update and development. Please ask [email protected] for a demonstration database or a copy of one of your live database with an integration account for testing.
Feed back
Each help topic has an email feedback button at the top left. For clarification on any aspects of this API, please send an email to [email protected].