Easier App Management

AIQ now lets you create and manage your API Integrations at group level. This means that you can create and configure an App in minutes, which can read and write data in all the entities within your group. You can edit an App and modify the entities it has access to at any time with immediate effect, as well as revoke access to the application completely, all through the user interface, without technical assistance.

OAuth 2.0 Authentication

This new feature has been built using OAuth 2.0, the industry-standard protocol for authentication and authorization. Unlike our current Token-based authentication method, connecting to AIQ SOAP API using Integration Applications does not require a Partner Key and User Key to work. Most importantly, it is not tied to a normal system user and does not allow interactive login, hence, no more ad-hoc users are needed for that purpose.

Developer Portal

After an Integration Application is created, the developer linked to the App will receive an email invitation to sign up to our brand-new Developer Portal. There they can access the App credentials, all relevant information about how to connect with our new SOAP API endpoint, the list of entities assigned to the App, and links to our API Wiki and Docs.

Availability

Integrations Applications and the Developer Portal are only available to customers on the AIQ3 Product Plan. If you would like to discuss switching to the AIQ3 Product Plan, please contact sales@accountsIQ.com.

See:

Using the Developer Portal and New API Endpoint 

API-Oauth Developer Portal 

The Integration Admin

The Integration Admin is someone at your company who is familiar with the scope of the integration and will set up and manage it. Only Practice Admins can set up Integration Admins. If the desired Integration Admin is a Practice Admin, they will have permission to manage integrations by default. Otherwise, follow the instructions below.

Setting the Integration Admin User Permission

1. In the group layer, go to Group Management > Edit Group Users and find the user who will be the Integration Admin. 
2. Click on the required Group User Name. Alternatively, add a new user. (See Setting up and Administering Group and Entity Users for more information on user setup)
3. In the Edit Group User screen, enable the permission Manage Integration Applications. 
   
   
    
4. Click Process.

Once the Integration Admin has the correct permissions (see previous section), they will have Integration Applications available as a menu option in the group layer.

1. Go to Group Management > Integration Applications. 
   
   
   
   
2. Click New Integration Application.
3. Select an Integration Type, either:
   •  New Integration: Create a new integration or build a partner integration that can be made available to other AIQ customers. 
   • AIQ Integrate: These are charged integrations managed by our team.
4. Click Next Step.

Option One: New Integration

1. To configure a New Integration, complete the following details:
   • Application Name: This is a mandatory field. It is used to identify the integration application in the list of apps and will be shown within the Developer Portal. You cannot change this later and it must be unique across all clients. 
   • Application Description: This is a mandatory field.  It is used to store a longer description of the integration app and its use. This will be shown within the Developer portal. Ensure it is meaningful.
   • Category: Select from our range of application types.
   • Integration/Developers Email: This is the email that will receive an Invite to access the Developer Portal to extract the credentials and information to create the integration itself (ClientId, ClientSecret, WSDL endpoint, etc).
   • API Permissions: Integrations can either Read or Read & Write information. You cannot change this later.
     
     
2. Select the entities this app can have access to via the API. You can change these later, if necessary, with immediate impact on the Integrations running for this App.
3. Click Create. 
4. A confirmation message will appear with instructions for verification. Click Copy and follow the instructions to send the OTP (One-Time Password) to the developer by a different mechanism than email (i.e., SMS, WhatsApp message, Phone call). 
   
   
    
5. The developer will then verify this App in the Portal with the provided OTP. (See Using the Developer Portal and New API Endpoint for more details). The OTP is valid for only 3 days. (If it expires before the developer verifies the App, the Integration Admin can reset it and send a new one.)  

Option Two: AIQ Integrate

1. Select the desired application type. This includes a Custom Integration option as well as preset types.
2. Check the disclaimer acknowledging that this application type is chargeable.
3. Click Next Step.
4. To configure AIQ Integration, complete the following details:
   •  Name: This is a mandatory field. It is used to identify the integration application in the list of apps and will be shown within the Developer Portal. You cannot change this later and it must be unique across all clients. 
   • Application Description: This is a mandatory field.  It is used to store a longer description of the integration app and its use. This will be shown within the Developer portal. Ensure it is meaningful, especially in the case of custom integrations.
   • Category: This is only available if you select AIQ Custom Integration.
5. Select the entities this app can have access to via the API. You can change these later, if necessary, with immediate impact on the Integrations running for this App.
6. Check the disclaimer acknowledging that you understand that our team will have access to your data.
7. Click Create. Our team will then receive notification.

Once the Integration Admin has the correct permissions (see section 2), they will be able to manage Integration Applications via the group layer.

Go to Group Management > Integration Applications. Here you can:

• View details about your applications.
• Use the Status filter or any of the other column search fields to filter your applications.
• Perform the actions outlined below.

Actions dropdown 

The Actions dropdown allows the following operations:

• Edit
• Manage Developer Portal Access
• Download Activity Log
• Revoke

Edit

In all cases, you can change with immediate effect:

• The Description 
• Which entities the App can have access to via the SOAP API.

For New Integrations and non-custom AIQ Integrations, you can also edit the Category. 

The fields that are greyed out are not available for editing.

Manage Developer Portal Access: No Linked Developer

If the App does not have a Developer linked (because the previous Developer was Revoked), you can register a new developer. An email invite or notification will be sent to the Developer, depending on whether they already have access to the Developer Portal.

Manage Developer Portal Access: Linked Developer

If the App has a valid Developer registered, you can see the Developer information, and if they have verified the OTP and when it was assigned to this App.

The following actions are available:

• Resend Invite: If the Developer hasn't signed up to the Portal after three days from when the first invite was sent, that invite will expire. They will therefore need a new invite.
• Revoke Access: This will prevent the Developer from accessing this App’s details in the Developer Portal with immediate effect. An email notification is sent to the Developer.
  
  
   
• Reset OTP: If the Developer didn’t verify the App in the Portal in time (the OTP is valid for 3 days only), you can use this option. A new OTP will be generated and displayed on the screen and an email notification will be sent to the Developer.
  
  

Download Activity Log 

A CSV file is available with all the information and events for a particular Application.

Revoke

Selecting Yes will stop all API integrations linked to this Application from running.