Welcome to Fibronostics API documentation. It contains documentation and tutorials for exposed endpoints allowing you manage your single/batch test taking process:
\n\nIn order to make API requests, you need to authenticate and generate an access_token Bearer Token valid for 1 hour that has to be provided in the Header using your client_id and client_secret obtained during the user creation setup with programmatic access. Refer to the Authenticate section.
Below API flow allows you to submit and retrieve a single test using the https://developers.fibronostics.com/.
\nhttps://auth.fibronostics.com: URL to generate an access token
https://api.fibronostics.com/master-data-service: URL for the Master Data Service
https://api.fibronostics.com/order-manager-service: URL for the Order Manager Service
In order to authenticate requests, request an access_token (see Generate access_token) by using POST https://auth.fibronostics.com. The token is valid for only 1 hour. Body should contain:
client_id generated from the user settings;
client_secret generated from the user settings.
In the following we assume you’re making the requests with a user created with API programmatic access and that the access_token is passed as a Bearer Token in the header. Refer to the Authenticate section.
If not known yet, retrieve the user entityId with GET https://api.fibronostics.com/master-data-service/v1/users/current to retrieve the user entityId (refer to GET Get current user).
If not known yet, retrieve the productId for LIVERFASt using GET https://api.fibronostics.com/order-manager-service/v1/products (refer to GET Get all products). If LIVERFASt doesn’t appear in the list of available products, it means your entity hasn’t access to it. Please contact our support.
Create a LIVERFASt order using POST https://api.fibronostics.com/order-manager-service/v1/orders/liverfast (refer to liverfast) by providing the required body data as below. Store/cache the orderId as this will be used to retrieve the results and the PDF
biomarkers
\ndateOfBloodSample
\nentityId
\nproductId
\npatient: dateOfBirth, gender, height, weight
\nUse GET https://api.fibronostics.com/order-manager-service/v1/orders/liverfast/:id?orderStatus=COMPLETED (refer to liverfast) by providing the orderId previously retrieved to fetch the results from the body response (result nested field).
Use GET https://api.fibronostics.com/order-manager-service/v1/orders/:id to retrieve the result PDF sheet.
In step 4. it is possible to create an account for the patient and provide her access to self-serve (read and download the result sheet) by providing the patient data in the LIVERFASt body request order. If the patient’s account already exists, provide its patientId.
\nIn step 4. it is possible to create an account for the prescriber and provide her access to self-serve (read and download result sheets for her patients) by providing the prescriber data in the LIVERFASt body request order. If the prescriber’s account already exists, provide its prescriberId.
\nNote: if you wish to batch process tests, please refer to the API use case : batch test take.
\nIn the following we assume you’re making the requests with a user created with API programmatic access and that the access_token is passed as a Bearer Token in the header. Refer to the Authenticate section.
Below API flow allows you to submit and retrieve a batch of tests via the https://portal.fibronostics.com/ by using the Excel file template provided withing the Fibronostics platform.
\nIf not known yet, retrieve the user entityId with GET https://api.fibronostics.com/master-data-service/v1/users/current to retrieve the user entityId (refer to GET Get current user).
If not known yet, retrieve the productId for LIVERFASt using GET https://api.fibronostics.com/order-manager-service/v1/products (refer to GET Get all products). If LIVERFASt doesn’t appear in the list of available products, it means your entity hasn’t access to it. Please contact our support.
Upload the Excel file with your LIVERFASt data with POST https://api.fibronostics.com/order-manager-service/v1/orders/liverfast/batch?batchReference=•••&entityId=•••&productId=••• (refer to liverfast) in order to validate the data to be processed. At this stage, order processing hasn’t yet started. This steps helps ensure the data provided is correct. Note the batch id returned in the payload for the following steps.
Use POST https://api.fibronostics.com/order-manager-service/v1/orders/liverfast/batch/:id (refer to liverfast) by providing the batch id previously retrieved to start the LIVERFASt batch processing. As soon as it is completed, you will receive per each test submitted one e-mail indicating its status.
At this point all the tests have been submitted are being/or have been processed. It is then possible to retrieve its data in a JSON format or via ZIP using our bulk export feature
\nWith the batchReference provided in step 4 use GET https://api.fibronostics.com/order-manager-service/v1/orders?batchReference=••• (refer to orders) to search and retrieve the orders data.
Start the report generation process with POST https://api.fibronostics.com/order-manager-service/v1/orders/report?reportTypes=ZIP&reportName=•••&orderStatuses=SUBMITTED,COMPLETED,FAILED&batchReference=••• (refer to POST Create report) in order to request the generation of the ZIP report containing all order PDF result sheets under batch reference batchReference. As soon as the report is completed, an e-mail is sent to the current user with the link to the download.
With the report id obtained in the response body, you can download the report with GET https://api.fibronostics.com/order-manager-service/v1/reports/:id (refer to GET Get report). The ZIP file will start downloading.
Note: if you wish to retrieve the result sheet order by order, please refer to the API use case : single test take.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authenticate","slug":"authenticate"},{"content":"Single test take","slug":"single-test-take"},{"content":"Batch test take","slug":"batch-test-take"}],"owner":"956213","collectionId":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","publishedId":"2sA3XLFQ9B","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"363C46","highlight":"43B4BC"},"publishDate":"2024-09-17T09:05:25.000Z"},"item":[{"name":"orders","item":[{"name":"liverfast","item":[{"name":"{id}","item":[{"name":"Get LIVERFASt order","id":"ee12e38e-3517-4b79-865f-717a01683d02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"User's time zone
\n","key":"Time-Zone","value":"Return the LIVERFASt order for the given order Id.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Ocp-Apim-Subscription-Key"},{"key":"value","value":"***"}]},"isInherited":true,"source":{"_postman_id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","name":"Order Manager API","type":"collection"}},"urlObject":{"path":["v1","orders","liverfast",":id"],"host":["https://api.fibronostics.com/order-manager-service"],"query":[],"variable":[{"id":"6c2bbc0d-dad5-45fe-8960-5cc28b88eba4","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"User's time zone
\n","key":"Time-Zone","value":"Start processing all LIVERFASt orders in the uploaded file
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Ocp-Apim-Subscription-Key"},{"key":"value","value":"***"}]},"isInherited":true,"source":{"_postman_id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","name":"Order Manager API","type":"collection"}},"urlObject":{"path":["v1","orders","liverfast","batch",":id"],"host":["https://api.fibronostics.com/order-manager-service"],"query":[],"variable":[{"id":"7b6e94e0-eff8-4856-a831-5ea47a5914de","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"User's time zone
\n","key":"Time-Zone","value":"Upload Excel file with LIVERFASt orders and analyze it
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Ocp-Apim-Subscription-Key"},{"key":"value","value":"***"}]},"isInherited":true,"source":{"_postman_id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","name":"Order Manager API","type":"collection"}},"urlObject":{"path":["v1","orders","liverfast","batch"],"host":["https://api.fibronostics.com/order-manager-service"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"batchReference","value":"(Required)
\n","type":"text/plain"},"key":"entityId","value":"(Required)
\n","type":"text/plain"},"key":"productId","value":"User's time zone
\n","key":"Time-Zone","value":"