Objective
Allow integration between myLIMS and other systems in a bidirectional manner (when applicable) with the purpose of exchanging specific data such as:
- Creating a Sample on myLIMS;
- Editing an Account on myLIMS;
- Consulting the results of Analysis of a Sample in myLIMS;
- Consulting the Prices of a Sample in myLIMS.
Limitations
The myLIMS APIs were not designed and should not be used for data extraction, so external systems or BI (Business Intelligence) tools should not be connected directly to myLIMS for extracting large volumes of data.
Our APIs contain limits on the number of records inserted or consulted, number of requests for periods of time, among other limitations to ensure the smooth functioning and stability of services to users and systems that use them.
For such applications, consult the Labsoft technical team.
What is REST?
REST (Representational State Transfer), is an abstraction of the World Wide Web architecture (Web), an architectural style that consists of a coordinated set of constraints applied to components, connectors and data elements within a distributed hypermedia system.
It ignores the component implementation details and the protocol syntax in order to focus on the roles of the components, the constraints on their interaction with other components and their interpretation of significant data elements.
HTTP Verbs
| GET |
Used to seek records |
| POST |
Used to create records |
| PUT |
Used to update records |
| DELETE |
Used to delete records |
HTTP status codes
HTTP defines a group of significant status codes that can be returned by the API. These can be leveraged to help consumers API route their responses accordingly.
| 200 Ok |
No error, successful operation |
| 201 Create |
Successfully creating a resource |
| 202 Accepted |
The request was received |
| 204 No Content |
The request was processed successfully, but you do not need any response body |
| 301 Moved Permanentlyd |
Feature has moved |
| 304 No Modified |
Resources has not been modified |
| 400 Bad Request |
Malformed syntax or a bad query |
| 401 Unauthorized |
Action requires user authentication |
| 403 Forbidden |
Authentication failed or invalid application ID |
| 404 Not Found |
Resource not found |
| 405 Not Allowed |
Method not allowed in the resort |
| 406 Not Acceptable |
Representation requested is not available for the resource |
| 408 Request Timeout |
Expired request |
| 410 Gone |
The URI used to refer to a resource |
| 415 Unsupported Type |
The representation is not supported for the resource |
| 500 Server Error |
Internal Server Error |
| 501 No Implemented |
Operation HTTP request not supported |
What is JSON
JSON (JavaScript Object Notation) is a lightweight data-interchange format, easy for humans to read and write and easy for machines to parse and generate. It is based on a subset of the JavaScript programming language.
JSON is a text format that is completely language independent, but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python,
and many others.
Security
Access to myLIMS is performed by an encrypted secure connection, using the TLS 1.2 standard, SHA-256 2048-bit RSA public key.
The Token is for the exclusive and restricted use of the company and any sharing of the Token (even with the integration provider) represents a serious security risk, as anyone else who knows the Token will be able to access the company's environment and data at any time.
The Token works as a password and, for this reason, after the integration approval, the new production environment Token should not be shared with suppliers and its access should be restricted. For this reason, the integration should provide a field for the insertion of the new production environment Token by the person in charge of the company (Labsoft client).
Authentication
The access security of all API interfaces is performed by an access token (x-access-key), which ensures that only the system that has knowledge of it can make use of this integration, consequently is required for all requests.
The access token (x-access-key) is related to a system user that will represent the external system integrated to myLIMS and is generated when the integration module is licensed. Thus, all the changes introduced by the external system will be identified, as well as date and time.
Good practices for system integration with myLIMS in order to avoid failures or blockages imposed by API limitations.
• When implementing data queries, define search criteria (filters) based on the minimal requirements for the application and definition of the strictly necessary fields. The purpose will always be to consult the smallest amount of data possible that meets the integration requirement. This will contribute to a shorter response time and prevent failures or blockages;
• Do not implement periodic queries in short intervals (polling in minutes for example) or use complex searches in the APIs. We have a mechanism that notifies an external API when there is a certain event in a given myLIMS record. In this way, your implementation will be able to consult the specific records of a certain id (key). Examples:
- Sample publication;
- Finalization of an Analysis Method;
- Account changes.
• Consult our technical team in case of any doubt.
Common features
Object PageResult<T>
This object is used to represent a result page of a request
| Result<T> |
Results list array of type T |
| Skip | Number of advanced records |
| Count | Number of records on this page |
| TotalCount | Total number of records that meet the search criteria |
Query Options
Option $filter
The query option $filter allows you to filter a set of features that are addressed by a URL request.
The expression specified with $ filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.
| Eq |
Equal |
Suppliers?$filter=Address/City eq ‘Redmond’ |
| Ne |
Not equal |
Suppliers?$filter=Address/City ne ‘London’ |
| Gt |
Greater than |
Products?$filter=Price gt 20 |
| Ge |
Greater than or equal |
Products?$filter=Price ge 10 |
| Lt |
Less than |
Products?$filter=Price lt 20 |
| Le |
Less than or equal |
Products?$filter=Price le 100 |
| And |
Logical and |
Products?$filter=Price le 200 and Price gt 3.5 |
| Or |
Logical or |
Products?$filter=Price le 3.5 or Price gt 200 |
Option $orderby
The query option $orderbyallows you to request resources in any order using 'asc' or 'desc'. If asc or desc is not specified the results will be sorted in ascending order.
GET /products?$orderby=Price desc
Option $top and $skip
The query option $toprequests the number of items in the collection consulted to be included in search results. The option$skip sets the number of items in the collection to be ignored and not included in the result.
GET /products?$top=2
GET /products?$top=5&$skip=10
Option $inlinecount
The query option $inlinecount allows you to visualize the value of the object TotalCount (total number of records that meet the search criteria).
GET /products?$inlinecount=allpages
