{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5eeaddda-5901-4238-b256-7025628af0f5","name":"HueDx API","description":"The HueDx Platform API is intended for use with authorized partners. Access and support questions can be directed to [engineering@huedx.com](engineering@huedx.com).\n\n## Environments\n\n1. Production— [https://hue-api.com/prod](https://hue-api.com/prod)  \n    This is the production API, user-facing, and most hardened.\n2. Test— [https://hue-api.com/test](https://hue-api.com/test)  \n    This is the test environment for the purposes of development and exploration. Test is often non-functional. You should not expect it to be functional at any given moment. Access to the test environment is not available by default and is granted on a case-by-case basis.\n    \n\n## Authentication\n\nTwo types of tokens are needed to authenticate with the API. Both are submitted in the header. Your header must contain the keys of `authorizationToken`and `appToken`.\n\nYou can obtain an `authorizationToken` via logging in using the `/login` endpoint. Contact [engineering@huedx.com](engineering@huedx.com) to acquire your first user account. Your first user will be the owner and admin of your orgnization, and can freely create users using the `/users` endpoint.\n\nAn `appToken` can only be provided manually to a user from a HueDx administrator. appTokens are distributed on a per-organization basis, and not to individual clients. Care should be taken to secure your appToken when sharing among your development team.\n\n## User Types\n\nThere are two types of users: members and admins. Admins can access all functionality of the API. Members are slightly more limited without the ability to:\n\n- Create new users\n- Update users\n- Delete users\n- Update Patients\n- Create new device types\n    \n\nNotes on different use-cases of the HueDx API\n\n- If you are developing a mobile app intended to be end-user-facing (as apposed to a mobile app intended to be used by a _clinician_ servicing a _patient_), your patient and user will be the same person, and care should be taken to keep them consolidated. The HueDx API is intended to give you the _flexibility_ to differentiate your users from patients, but this is not always the desired behavior of some products.\n- You may consider doing your own user and patient management. Using HueDx's user and patient databases is not necessary, as each HueCard Result can be accessed with a `resultId` explained later in this documentation. You may choose to keep track of each `resultId` independently of the HueDx Cloud user and patient databases. To access the API, however, you do need at least one user.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19074653","collectionId":"5eeaddda-5901-4238-b256-7025628af0f5","publishedId":"UyrADvrK","public":true,"publicUrl":"https://docs.hue-api.com","privateUrl":"https://go.postman.co/documentation/19074653-5eeaddda-5901-4238-b256-7025628af0f5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.4","publishDate":"2023-02-21T20:46:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"dea25f16-5d5c-49d1-bcba-7939cd0916df","owner":"19074653","values":[{"key":"stage","value":"prod","enabled":true,"type":"default"},{"key":"baseUrl","value":"https://hue-api.com","enabled":true,"type":"default"},{"key":"appToken","value":"f2456746-e614-4b21-bcab-7357e023e2f2","enabled":true,"type":"default"},{"key":"authorizationToken","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjcmVhdGVkQXQiOiIyMDIzLTAzLTEwVDE3OjExOjQ4LjAxMTYyMSIsInVzZXJUeXBlIjoic2VydmljZSIsImNyZWF0ZWRCeSI6ImE0MDkxOWUwLWEzN2EtMTFlZC1iM2FhLWFjZGU0ODAwMTEyMiIsIm9yZ0lkIjoiNTY1MGYzYzYtYTM3YS0xMWVkLWIzYWEtYWNkZTQ4MDAxMTIyIn0.MtkYT4HsZcY-FR7RYtb8g5h87uAkA_-GFWgoY9tUenM","enabled":true,"type":"default"},{"key":"userEmail","value":"test@huedx.com","enabled":true,"type":"default"},{"key":"userPassword","value":"Password123","enabled":true,"type":"default"},{"key":"userId","value":"92d60c88-d565-11ed-8ca5-96901a9a9e4f","enabled":true,"type":"default"},{"key":"qrId1","value":"77386971058235","enabled":true,"type":"default"},{"key":"qrId2","value":"77171723578032","enabled":true,"type":"default"},{"key":"resultId1","value":"15d31178-c28b-11ed-8252-6a5258efd04f","enabled":true,"type":"default"},{"key":"resultId2","value":"5135c170-c26d-11ed-9766-6a4bb1ba4cbf","enabled":true,"type":"default"},{"key":"deviceTypeId","value":"HUE-TEST-1-1","enabled":true,"type":"default"},{"key":"patientId1","value":"e0f284a8-bb72-11ed-aefd-66801e0ae56d","enabled":true,"type":"default"},{"key":"patientId2","value":"ab3bc48c-bb72-11ed-848a-76ee915f8e35","enabled":true,"type":"default"},{"key":"tag","value":"my first experiment","enabled":true,"type":"default"},{"key":"jobId","value":"ecee2636-f2f3-4da5-95ff-53789251c2c4","enabled":true,"type":"default"},{"key":"experimentName","value":"test","enabled":true,"type":"default"},{"key":"lotNumber1","value":"0","enabled":true,"type":"default"},{"key":"lotNumber2","value":"1","enabled":true,"type":"default"}],"published":true}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://hue-api.com/favicon.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"},{"label":"Production","value":"19074653-dea25f16-5d5c-49d1-bcba-7939cd0916df"}],"canonicalUrl":"https://docs.hue-api.com/view/metadata/UyrADvrK"}