{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","name":"Order Manager API","description":"Welcome to Fibronostics API documentation. It contains documentation and tutorials for exposed endpoints allowing you manage your single/batch test taking process:\n\n- Order management: [orders](https://developers.fibronostics.com/#96e0ab29-19c9-4410-be93-2b2c333c87a5) to and [reports](https://developers.fibronostics.com/#c91fde88-0617-4458-983e-8bdf92c0bd9f);\n    \n- User management: [users](https://developers.fibronostics.com/#66599b8e-274f-4bb2-a16d-33d3694812ef), [entities](https://developers.fibronostics.com/#99ca95ca-b283-4617-9d36-9a568de5daf0), [products.](https://developers.fibronostics.com/#5076df14-7f13-47eb-9baa-e7560c3da94e)\n    \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](https://developers.fibronostics.com/#authenticate) section.\n\nBelow API flow allows you to submit and retrieve a single test using the [https://developers.fibronostics.com/](https://developers.fibronostics.com/).\n\n- `{{authUrl}}`: URL to generate an access token\n    \n- `{{urlMDS}}`: URL for the Master Data Service\n    \n- `{{urlOMS}}`: URL for the Order Manager Service\n    \n\n# Authenticate\n\nIn order to authenticate requests, request an `access_token` (see [Generate access_token](https://developers.fibronostics.com/#dd8d4de4-72c1-4932-a83a-69e6c2e27fd0)) by using `POST {{authUrl}}`. The token is valid for only 1 hour. Body should contain:\n\n1. `client_id` generated from the user settings;\n    \n2. `client_secret` generated from the user settings.\n    \n\n# Single test take\n\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](https://developers.fibronostics.com/#authenticate) section.\n\n## Steps\n\n- If not known yet, retrieve the user entityId with `GET {{urlMDS}}/v1/users/current` to retrieve the user entityId (refer to [GET Get current user](https://developers.fibronostics.com/#4844a56e-f730-4f52-8ff2-71bdbeaef00b)).\n    \n- If not known yet, retrieve the `productId` for LIVERFASt using `GET {{urlOMS}}/v1/products` (refer to [GET Get all products](https://developers.fibronostics.com/#674cfea6-8b2a-4723-974d-344d2b4876a1)). If LIVERFASt doesn’t appear in the list of available products, it means your entity hasn’t access to it. Please contact our support.\n    \n- Create a LIVERFASt order using `POST {{urlOMS}}/v1/orders/liverfast` (refer to [liverfast](https://developers.fibronostics.com/#15de41d7-e931-48b9-907b-3fcf2217d4c4)) by providing the required body data as below. Store/cache the orderId as this will be used to retrieve the results and the PDF\n    \n    - biomarkers\n        \n    - dateOfBloodSample\n        \n    - entityId\n        \n    - productId\n        \n    - patient: dateOfBirth, gender, height, weight\n        \n- Use `GET {{urlOMS}}/v1/orders/liverfast/:id?orderStatus=COMPLETED` (refer to [liverfast](https://developers.fibronostics.com/#15de41d7-e931-48b9-907b-3fcf2217d4c4)) by providing the `orderId` previously retrieved to fetch the results from the body response (result nested field).\n    \n- Use `GET {{urlOMS}}/v1/orders/:id` to retrieve the result PDF sheet.\n    \n\n## Additional notes\n\n- 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.\n    \n- In 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.\n    \n\n**Note**: if you wish to batch process tests, please refer to the API use case : [batch test take](https://developers.fibronostics.com/#batch-test-take).\n\n# Batch test take\n\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](https://developers.fibronostics.com/#authenticate) section.\n\nBelow API flow allows you to submit and retrieve a batch of tests via the [https://portal.fibronostics.com/](https://portal.fibronostics.com/) by using the Excel file template provided withing the Fibronostics platform.\n\n## Steps\n\n- If not known yet, retrieve the user entityId with `GET {{urlMDS}}/v1/users/current` to retrieve the user `entityId` (refer to [GET Get current user](https://developers.fibronostics.com/#4844a56e-f730-4f52-8ff2-71bdbeaef00b)).\n    \n- If not known yet, retrieve the `productId` for LIVERFASt using `GET {{urlOMS}}/v1/products` (refer to [GET Get all products](https://developers.fibronostics.com/#674cfea6-8b2a-4723-974d-344d2b4876a1)). If LIVERFASt doesn’t appear in the list of available products, it means your entity hasn’t access to it. Please contact our support.\n    \n- Upload the Excel file with your LIVERFASt data with `POST {{urlOMS}}/v1/orders/liverfast/batch?batchReference=•••&entityId=•••&productId=•••` (refer to [liverfast](https://developers.fibronostics.com/#15de41d7-e931-48b9-907b-3fcf2217d4c4)) 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.\n    \n- Use `POST {{urlOMS}}/v1/orders/liverfast/batch/:id` (refer to [liverfast](https://developers.fibronostics.com/#15de41d7-e931-48b9-907b-3fcf2217d4c4)) 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.\n    \n\nAt 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\n\n## Retrieve orders data (JSON)\n\nWith the batchReference provided in step 4 use `GET {{urlOMS}}/v1/orders?batchReference=•••` (refer to [orders](https://developers.fibronostics.com/#3e0de045-a48f-43ac-8118-5ae8a3a93f6d)) to search and retrieve the orders data.\n\n## Retrieve orders ZIP (PDF result sheets)\n\n- Start the report generation process with `POST {{urlOMS}}/v1/orders/report?reportTypes=ZIP&reportName=•••&orderStatuses=SUBMITTED,COMPLETED,FAILED&batchReference=•••` (refer to [POST Create report](https://developers.fibronostics.com/#6f950065-f289-4e3a-9d0a-c82e8ea9a98a)) 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.\n    \n- With the report id obtained in the response body, you can download the report with `GET {{urlOMS}}/v1/reports/:id` (refer to [GET Get report](https://developers.fibronostics.com/#df61242c-660a-4544-9c13-d1726b817666)). The ZIP file will start downloading.\n    \n\n**Note**: if you wish to retrieve the result sheet order by order, please refer to the API use case : [single test take](https://developers.fibronostics.com/#single-test-take).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"956213","team":5614663,"collectionId":"6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","publishedId":"2sA3XLFQ9B","public":true,"publicUrl":"https://developers.fibronostics.com","privateUrl":"https://go.postman.co/documentation/956213-6cb6e51b-61b8-445c-a8f9-428a4f82f8dd","customColor":{"top-bar":"FFFFFF","right-sidebar":"363C46","highlight":"43B4BC"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Fibronostics APIs | Liver diagnostics"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/c933d45d-85ef-47eb-8c45-3450d2b92b96/Rmlicm9ub3N0aWNzIExvZ28gUG9zdG1hbi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"363C46","highlight":"43B4BC"}},{"name":"light","logo":"https://content.pstmn.io/c933d45d-85ef-47eb-8c45-3450d2b92b96/Rmlicm9ub3N0aWNzIExvZ28gUG9zdG1hbi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"363C46","highlight":"43B4BC"}}]}},"version":"8.11.6","publishDate":"2024-09-17T09:05:25.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Fibronostics APIs | Liver diagnostics","description":""},"logos":{"logoLight":"https://content.pstmn.io/c933d45d-85ef-47eb-8c45-3450d2b92b96/Rmlicm9ub3N0aWNzIExvZ28gUG9zdG1hbi5wbmc=","logoDark":"https://content.pstmn.io/c933d45d-85ef-47eb-8c45-3450d2b92b96/Rmlicm9ub3N0aWNzIExvZ28gUG9zdG1hbi5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b9acb5a0be1cec96c3027227bcb2b9b2f452f242a7677df1f9c8effe1d0639f4","favicon":"https://res.cloudinary.com/postman/image/upload/v1696320972/team/bruzxc3hx44lmaeoqrnl.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developers.fibronostics.com/view/metadata/2sA3XLFQ9B"}