The UNIFI API version is dependent on the version of UNIFI it is released alongside. The UNIFI API is evolving and improving, and the current version of the UNIFI API is 1.0. This version can be used with UNIFI 1.9.0.
If you would like to join our UNIFI API beta team to learn about and help us build the UNIFI API we would love to hear from your, please contact us.
Currently released versions of UNIFI have a in built integration with Watson LIMS. This is an integral part of UNIFI and comes with every install of UNIFI, it just needs to be configured.
There is no other “built-in” integration as part of UNIFI, this functionality will be offered through the UNIFI API which is being evolved continually.
UNIFI does have some ability to import sample results through a CSV file or via copy/paste, and export data to a file in a number of formats. See the tutorials for more details.
The beta area provides information to customers taking part in assessing our API whilst it is under development. The beta program helps us ensure the API meets customers needs, and lets customers request and assess functionality so they can build the best applications with the API. The beta program will be ongoing and is open to customers interested in collaborating with Waters, please use the contact us page or contact Richard Woodhead if you would like to find out more.
Contact support (UNIFIInterfacingSupport@waters.com) for access to the beta release.
The Tutorials are a good starting point
For every API endpoint listed in the API Reference, there is an example request with example response and an option to try it out.
We have prepared example code in the Hands on Labs section(s) which show how to make the requests.
For many examples you need to obtain a “token”. Please see the Authentication and Security section for more information and example code.
You can find general information on error handling within the Guidelines and a list of error codes and sub-error codes.
The Hands-On Labs section includes examples of how to create an application in Javascript, C# and Java.
For many examples you need to obtain a “token”. Please see the Authentication and Security section for more information and example code.
Either contact support (UNIFIInterfacingSupport@waters.com) or use the Contact Me section of the website for technical help.
We will continue to develop and evolve the API, and work with customers to achieve this. We are planning to release the next version of the API early in 2019, as part of a major UNIFI release.
The api shall be released about every 3 months.
Yes! We use semantic versioning, so there is a major, minor and patch version for each release. The major version number is part of the URL.
We try to keep the API backwards compatible, and adhere to the following approach:
Where a release contains no breaking changes then the major version number is unchanged – and so the URL you use to access the API remains the same. In this case either the minor version or patch version number is incremented.
Where a release contains breaking changes (for example where endpoints have been removed, or fields removed or changed within data models), the major version is incremented. This means that the URL to access the new version is different. We will aim to support at least the previous version in parallel with the new version for a period, giving you time to switch to the new API version at a time that suits you.
Your client application can use the /serverinformation endpoint to find out the exact build number of the current version.
Yes:”unifiapi.waters.com”. See the demo server page for more information
Please use the “Contact us” form.
Please use the “Contact us” form.
Did you already request an account for the demo server (these can be different accounts than for this documentation site)? If not please use the contact form to get an account.
If you have an account and you’re sure the password is correct, then your account might have been locked after too many failed events. If you think this might be the case please also contact us using the contact form to get the user unlocked.
A token is a string that is used to verify that you have access to the server. A token has a limited validity period after which you need to obtain a new token.
A token is obtained by authenticating with username and password.
Read more details in the Authentication and Security section.
Tokens have expiration times. So your token might be expired. Please try obtaining a new token.
See the Security and Authentication section for more information.
A UNIFI adminstrator has to create (and enable!) your application in the “External Application Security Configuration” page using the link with that name on the UNIFI adminstration page (in UNIFI Portal).
See the UNIFI help for more information on this.
A UNIFI adminstrator has to access the “External Application Security Configuration” page using the link with that name on the UNIFI administration page (in UNIFI Portal).
See the UNIFI help for more information on this page.
Simplest way is to use an HTTP library for the programming language that you’re using to make the requests. And to read the response use a JSON library.
Please keep in mind that you have to take care of obtaining a token to be able to call endpoints. So the Authentication and Security section for details.
No, there is no SDK in form of client side libraries.
The UNIFI API is exposed as an HTTP API to be as flexible as possible and accessible from many diffferent programming languages. All major languages have support for accessing HTTP APIs.
And for several languages there is also OData support. See the OData section for details on OData.
The API is HTTP based and can therefore be accessed using many different programming languages.
Yes, Java has extensive HTTP support.
There are also OData libraries for Java.
The API is supported from UNIFI version 1.9 onwards.
It has to be installed using a separate installer after UNIFI has been installed.
For installing and using the API no additional licenses are required.
The users that can use the API needs to be registered as UNIFI users in the respective UNIFI installation.
For registering users in UNIFI you have to have the appropriate licenses.
You can register any number of clients without any special licenses or additional costs.
The limitation is the number of users that have an active license assigned in UNIFI.
A single user can have multiple API based applications running in parallel also on different machines.
Currently we only support English.
If this is very important for you please use the Contact form to let us know and we will consider it for the future.
Yes, the API is an add on to UNIFI and can’t be run stand alone.
You can install the API on any UNIFI installation as long as it has version 1.9 (or higher)
You can start looking at the Hands on Labs pages.
Feel free to use the contact form when you encounter problems or don’t know how to continue.
Please use the contact form to see whether we can help establishing contact.
We have created example applications to help you getting started. See the Hands on Labs documentation for these examples.