The Demo account is used to illustrate the OpenAPI examples and provide interactive support. It is generally the first stop in exploring the API for all of our trading partners, and must be used in accordance with the Terms of Use.
Use of the API and interactive documentation requires a key. Please contact us to acquire a Demo account key.
API keys are tied to specific accounts. Once you have set up an account with us, you will be issued an account key for our test and production environments.
To use the key in the interactive documentation, click on the authorize button and paste it the Value field, then click the Authorize button.
To use the key in your testing tools or applications, you must include it in a header named "x-functions-key" as the header value.
If you are going to be using our test kits, then you must use the endpoints in the OmegaQuant Test Kit section.
If you are going to be using test kits from someone other than us, you must use the endpoints in the Non-OmegaQuant Test Kit section.
There is no circumstance in which you would use both. Only the Demo account is set up to access both, and only for demonstration purposes.
The OpenAPI compliant documentation can be accessed as either a JSON or YAML file, which can be used by commonly available tools to generate client code in your preferred programming language. More information on the use of these tools can be found here.
Please note that our API is intended to convey information between OmegaQuant and our clients as an alternative to sending daily spreadsheets. It is not intended to be embedded directly into client applications, and we make no service guarantees. We recommend that clients create their own database for housing registration, status, and results data and use our API to keep it in sync. This information is intended to help clients understand our process and the expected timeframes, and to avoid running into usage limits. Please see the Typical Workflow below for further details and recommendations.
Typically, test kits should be registered at the time the test sample is collected.
At that point, either the /registerkit (for our kits) or /sample/register (for non-OmegaQuant kits) endpoint should be called to send us the sample's information.
The sample will then be in a "Registered" status. More on that later.
Samples will arrive at our lab at varying intervals based on the postal service, but typically within 3-7 days.
Once a sample arrives, its barcode is scanned, allowing us to locate the registration information sent earlier, and tie it to the sample for updating our systems.
The sample will then be in a "Received" status.
The sample will be prepped and processed by the lab, during which time it will be in a "Processing" status.
Should the sample prove non-sufficient for running a test, it will move to a "QNS" status (Quality Not Sufficient), and no results will be available.
You may chose to provide the patient with a new test kit, but there will be no further activity on this sample.
Once the test is complete and the results have been reviewed by Quality Control, them sample will be in a "Completed" status, and results will be available.
The entire test and QC process generally takes 3-5 business days.
Please note that a test's status is not going to change more than once per day, so frequent periodic checks are unnecessary and wasteful.
The most efficient approach to checking the status of tests is to use the /status/search/{fromDate}/{toDate} (for our kits) or the /sample/status/search/{fromDate}/{toDate} (for non-OmegaQuant kits) endpoint to do a daily search for status changes from the previous day.
The most efficient approach to retreiving test results is to use the /results/search/{fromDate}/{toDate} (for our kits) or /sample/results/search/{fromDate}/{toDate} (for non-OmegaQuant kits) endpoint to do a daily search for results from the previous day.
An example of a recommended client approach would be as follows: