AlisQI API overview

AlisQI provides an API to READ and WRITE all results (analysis sets and selection lists) and specifications.

This covers all master data as well as transactional (laboratory or quality) data.

Technique

The API sends JSON over HTTPS.

The actual data structure depends on the definition of the analysis-set involved. See parameter documentation below for more details.

Endpoints

The AlisQI API offers several endpoints. 

Currently these are:

  • getResults - retrieving data from AlisQI
  • storeResults - sending data to AlisQI
  • getSpecificationVersion - retrieving specification data from AlisQI
  • storeSpecificationVersion - sending specification data to AlisQI
  • getSetDefinition - retrieving meta data on the analysis-set

Endpoint documentation

Since alle API endpoints deal with user defined analysis-sets in AlisQI, there is no generic API documentation.

Each endpoint has few generic parameters. The payload of the API calls however fully depends on the user defined structure of the analysis-set involved.

Full documentation is available for every analysis-set and selection list within the application. This documentation can be opened from the Results overview:

More ยป API documentation

Authentication

All API calls are subject to authentication. In order to invoke the AlisQI API endpoints, developers need to create an authentication token.

The API supports the Bearer authentication specification. See our GitHub repo for example code.

Authentication tokens

Each token is connected to a single user. The READ/WRITE permission this user has for analysis-sets (via its user group), also apply to the API invocations. More information on the user and permission management in AlisQI.

To manage API authentication tokens, open can be managed from the User management screen or from the API documentation.

To create a new token, select a user account and click save. When you access the API using this token, you can perform any actions that the selected user has permission for. For example, if you select a user who only has read access to a particular analysis-set, you will not be able to use the storeResults operation using that token.

You can also specify an IP address whitelist for each token for added security.

It is possible to add multiple tokens for a single user account if desired.

Note that tokens are not synchronized between AlisQI installations. For example, if you have a test or validation installation, you will need to create fresh tokens to access the API.

We strongly advise to create a separate user account per integration, and to deactivate this user. This way the account can only be used for API invocations.

Permissions

The API uses the standard permission management system to validate requests.

Since an authentication token is linked to a user, each API call is validated against the permission this user has, granted to its user group.

Only analysis-set permissions are relevant in the context of the API.

Still need help? Contact Us Contact Us