When working with our API, we will have two main endpoints: /provider and /doctor
The workflow is as follows: first, you need to register a doctor in our system using an API key, which we call PSK.
After that, you will receive a token, which we call DAT, and with the DAT token, you will have access to the /doctor endpoint.
A PSK key will be a string similar to the following:PSK.4rZyB82mW0hTWoqCgq1dezLPZY8aoYlHUTZ6VgqAYKaXH9sK1EnIkwSGFYvnQ2aJHmtBmjBTiTYQAsszrpcyHxsT14Iuvt1jVkHo
And the UAT token will be in the following format:UAT.uQ5Ke2f1Z4GhCbtsN9Y2y5P5NAHvqVoFvF2QDrXayQe5v1UsmXtgQNVSYSKpz19XN9xmTOCWDKLdpGv2mGfx5XbkisFyljuxlkoN
Please note that the PSK key should only be used on the server-side and should never be used in places like the user's browser cookie or anywhere that can be visible.
However, the UAT token can be stored in the user's browser cookie or in your database
Accepted values: male, female
\n","type":"text"},{"key":"first_name","value":"John","type":"text"},{"key":"last_name","value":"Doci","type":"text"},{"key":"country_code","value":"IR","description":"example: IR, RU, AE
\n","type":"text"},{"key":"mobile","value":"09123456789","description":"example: 09123456789 or 9123456789
\n","type":"text"}]},"url":"https://{{base_domain}}/v1/provider/doctor/register","urlObject":{"protocol":"https","path":["v1","provider","doctor","register"],"host":["{{base_domain}}"],"query":[],"variable":[]}},"response":[{"id":"dd05791d-1e02-4324-9a38-beca90e8df20","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"gender","value":"male","description":"Accepted values: male, female","type":"text"},{"key":"first_name","value":"John","type":"text"},{"key":"last_name","value":"Doci","type":"text"},{"key":"country_code","value":"IR","description":"example: IR, RU, AE","type":"text"},{"key":"mobile","value":"09123456789","description":"example: 09123456789 or 9123456789","type":"text"}]},"url":"https://{{base_domain}}/v1/provider/doctor/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 02 Sep 2024 16:04:21 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": {\n \"code\": 0,\n \"message\": null\n },\n \"data\": {\n \"exists\": false,\n \"access_token\": \"DAT.LpEny5Y0pY7NdOG2deBOgGjJzjQ1MkPVhplaLdCwvQX9OTImacSi4xMNVBlN4LnbAqddTSfljGxabK8LoJiLoGBDay0buWxVk96B\"\n }\n}"},{"id":"7244130d-155a-4a87-abe6-26f13c141a1d","name":"Invalid PSK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"gender","value":"male","description":"Accepted values: male, female","type":"text"},{"key":"first_name","value":"John","type":"text"},{"key":"last_name","value":"Doci","type":"text"},{"key":"country_code","value":"IR","description":"example: IR, RU, AE","type":"text"},{"key":"mobile","value":"09123456789","description":"example: 09123456789 or 9123456789","type":"text"}]},"url":"https://{{base_domain}}/v1/provider/doctor/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 02 Sep 2024 15:58:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": 11000,\n \"message\": \"Your PSK key is invalid\"\n },\n \"data\": []\n}"}],"_postman_id":"ef2126dc-60ee-4550-a06b-f9629e4dfc8e"}],"id":"51e7971e-2ad5-4a7d-984d-64bb9f561f59","description":"Using the PSK key, you first register a doctor and then receive a DAT token in response
PNG, JPG, GIF - max size: 5MB
\n","type":"file","src":"N4G5E4P3Z/svgviewer-png-output.png","disabled":true},{"key":"experience_from","value":"2005","description":"Since what year has he/she been practicing medicine?
\n","type":"text","disabled":true},{"key":"certification_number","value":"123987456","type":"text","disabled":true}]},"url":"https://{{base_domain}}/v1/doctor/profile","urlObject":{"protocol":"https","path":["v1","doctor","profile"],"host":["{{base_domain}}"],"query":[],"variable":[]}},"response":[{"id":"bf38e6cf-09f4-403b-bfc3-37b92c8ae8be","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"Max","type":"text","disabled":true},{"key":"last_name","value":"Doci","type":"text"},{"key":"gender","value":"male","type":"text","disabled":true},{"key":"born_date","value":"1980-10-20","type":"text","disabled":true},{"key":"profile_photo","description":"PNG, JPG, GIF - max size: 5MB","type":"file","src":"N4G5E4P3Z/svgviewer-png-output.png","disabled":true},{"key":"experience_from","value":"2005","description":"Since what year has he/she been practicing medicine?","type":"text","disabled":true},{"key":"certification_number","value":"123987456","type":"text","disabled":true}]},"url":"https://{{base_domain}}/v1/doctor/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jan 2025 10:38:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"http://local.houshyaar.com:8080"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=fiP3E%2BpNdM6b4wz8A2MXMzI%2B%2FAEcGE8lWVv9JpKxHzsB5vKjklZxlRp%2Fspi2E35ZuVAjzPbJCgS6g2CIqEwO8hUaSt%2BB0k4dzNKlZn75dHGwTdxFv5GfmeTC5okJjhCQBIJetg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9056acea69d18256-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=1972&min_rtt=1818&rtt_var=792&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2829&recv_bytes=1105&delivery_rate=1592959&cwnd=251&unsent_bytes=0&cid=4b829776a4c4b740&ts=306&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": {\n \"code\": 0,\n \"message\": null\n },\n \"data\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doci\",\n \"gender\": \"male\",\n \"mobile_number\": \"+989124455667\",\n \"email_address\": null,\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-28T18:43:13.000000Z\",\n \"create_timestamp\": 1724870593\n }\n }\n}"}],"_postman_id":"d134514d-4ac6-4fbf-a4c6-f6276cd81f7e"}],"id":"0f786bd9-d126-463e-9d6c-da1ba6baa677","_postman_id":"0f786bd9-d126-463e-9d6c-da1ba6baa677","description":""},{"name":"Forms","item":[{"name":"List","id":"4af7a1df-6bc4-4bbd-a90a-1adb83c3e3dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{base_domain}}/v1/doctor/forms","urlObject":{"protocol":"https","path":["v1","doctor","forms"],"host":["{{base_domain}}"],"query":[],"variable":[]}},"response":[{"id":"e89ef593-c742-4b1b-a2e2-3b58d7ba058f","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{base_domain}}/v1/doctor/forms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jan 2025 10:43:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"http://local.houshyaar.com:8080"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=pJ%2FSA1g3GA6%2B2wZ97c2youddnq8WEvKSYkBo5mpGILALtpimzc9m4vuSChf0Osy4Cu4e4z1T%2Fw5zhEUjh%2FOS5wEUO89r3jVz3a7Sd9T65tCyFiTy4W1DgiVDzQTuuym2WOBFpg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9056b4166efbc950-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2882&min_rtt=2707&rtt_var=1140&sent=3&recv=5&lost=0&retrans=0&sent_bytes=219&recv_bytes=1108&delivery_rate=534909&cwnd=250&unsent_bytes=0&cid=9ce2e7b5a4c19cef&ts=313&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"hashid_form\": \"Bn25kPjmz4Dpz0qG\",\n \"name\": \"Test Form X10\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-09-05T20:41:20.000000Z\",\n \"create_timestamp\": 1725568880\n }\n },\n {\n \"hashid_form\": \"oygX5N4xzYpn8RWQ\",\n \"name\": \"test form 5\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-09-02T10:36:47.000000Z\",\n \"create_timestamp\": 1725273407\n }\n },\n {\n \"hashid_form\": \"Gk5nJMjXBvVD9Oly\",\n \"name\": \"Form X4\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": null,\n \"create_timestamp\": null\n }\n },\n {\n \"hashid_form\": \"1D72lavgXYJxz3oA\",\n \"name\": \"Form X3\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": null,\n \"create_timestamp\": null\n }\n },\n {\n \"hashid_form\": \"keOd20jZpvlqRQ1M\",\n \"name\": \"test form 5\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-31T12:30:56.000000Z\",\n \"create_timestamp\": 1725107456\n }\n },\n {\n \"hashid_form\": \"KnwGzpYzojmb1EWe\",\n \"name\": \"test form 4\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-28T19:02:35.000000Z\",\n \"create_timestamp\": 1724871755\n }\n },\n {\n \"hashid_form\": \"Zpxl0z49A4Nm37bw\",\n \"name\": \"test form\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-28T18:54:36.000000Z\",\n \"create_timestamp\": 1724871276\n }\n },\n {\n \"hashid_form\": \"LpEny5Y0pY7NdOG2\",\n \"name\": \"test form\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-28T18:54:15.000000Z\",\n \"create_timestamp\": 1724871255\n }\n },\n {\n \"hashid_form\": \"930yRPjrLv7p65oq\",\n \"name\": \"test form\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-08-28T18:53:43.000000Z\",\n \"create_timestamp\": 1724871223\n }\n }\n ],\n \"links\": {\n \"first\": \"http://api.houshyaar.com/v1/doctor/forms?page=1\",\n \"last\": \"http://api.houshyaar.com/v1/doctor/forms?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://api.houshyaar.com/v1/doctor/forms?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://api.houshyaar.com/v1/doctor/forms\",\n \"per_page\": 20,\n \"to\": 9,\n \"total\": 9\n }\n}"}],"_postman_id":"4af7a1df-6bc4-4bbd-a90a-1adb83c3e3dc"},{"name":"Show","id":"170420fe-bbb2-4626-aec1-1db71c834176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{base_domain}}/v1/doctor/forms/{{hashid_form}}","urlObject":{"protocol":"https","path":["v1","doctor","forms","{{hashid_form}}"],"host":["{{base_domain}}"],"query":[],"variable":[]}},"response":[{"id":"29121f8a-33be-4ef1-8af3-81b0d96a59f9","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{base_domain}}/v1/doctor/forms/{{hashid_form}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jan 2025 10:45:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"http://local.houshyaar.com:8080"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=PiSprNhkbBYH9C6%2Fl%2B50aUGoQ5YrSu10sAkmcGC5UoLkSI5y9kbhsk%2BTw48MQoQRH1Sc6iHnxFuJiiWkyTGksPUd0N5pIJw%2FbzrT8w331p%2FufsyCd%2BsY%2BkoF0O8c%2FuIc64dpOg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9056b6d76d78c92b-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2452&min_rtt=2375&rtt_var=945&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2830&recv_bytes=870&delivery_rate=1219368&cwnd=251&unsent_bytes=0&cid=3f86752b451cb512&ts=275&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": {\n \"code\": 0,\n \"message\": null\n },\n \"data\": {\n \"hashid_form\": \"Bn25kPjmz4Dpz0qG\",\n \"name\": \"Test Form X10\",\n \"time\": {\n \"time_zone\": \"UTC\",\n \"create_time\": \"2024-09-05T20:41:20.000000Z\",\n \"create_timestamp\": 1725568880\n },\n \"fields\": [\n {\n \"hashid_field\": \"J5pkyQYkoYgeznwP\",\n \"order\": 1,\n \"type\": \"text\",\n \"title\": \"Full name\",\n \"description\": \"Enter your first and last name 2\",\n \"values\": [],\n \"validation\": {\n \"required\": true\n }\n },\n {\n \"hashid_field\": \"ONb0kxj3RY6n1QPw\",\n \"order\": 2,\n \"type\": \"radio\",\n \"title\": \"Body type\",\n \"description\": null,\n \"values\": [\n \"Overweight\",\n \"Underweight\",\n \"Average\"\n ],\n \"validation\": {\n \"required\": true\n }\n },\n {\n \"hashid_field\": \"Mlbpkavd0vBGA30D\",\n \"order\": 3,\n \"type\": \"file\",\n \"title\": \"Result of complete check-up test\",\n \"description\": \"Upload your PDF file if available\",\n \"values\": [],\n \"validation\": {\n \"required\": false\n }\n },\n {\n \"hashid_field\": \"7PwaQzjQGve8N9VE\",\n \"order\": 4,\n \"type\": \"long_text\",\n \"title\": \"Chief Complaint\",\n \"description\": \"Enter full details of your problem\",\n \"values\": [],\n \"validation\": {\n \"required\": true\n }\n }\n ]\n }\n}"}],"_postman_id":"170420fe-bbb2-4626-aec1-1db71c834176"},{"name":"Create","id":"46848925-ffd2-4cbe-a485-fdd3b03a2f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Normal patients form\",\n\t\"fields\": [\n\t\t{\n\t\t\t\"order\": 1,\n\t\t\t\"title\": \"Full name\",\n\t\t\t\"description\": \"Enter your first and last name\",\n\t\t\t\"type\": \"text\",\n\t\t\t\"validation\": {\n\t\t\t\t\"required\": true\n\t\t\t}\n\t\t},\n {\n\t\t\t\"order\": 2,\n\t\t\t\"title\": \"Body type\",\n\t\t\t\"type\": \"radio\",\n\t\t\t\"values\": [\"Overweight\", \"Underweight\", \"Average\"],\n\t\t\t\"validation\": {\n\t\t\t\t\"required\": true\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"order\": 3,\n\t\t\t\"title\": \"Result of complete check-up test\",\n\t\t\t\"description\": \"Upload your PDF file if available\",\n\t\t\t\"type\": \"file\",\n\t\t\t\"validation\": {\n\t\t\t\t\"required\": false\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"order\": 4,\n\t\t\t\"title\": \"Chief Complaint\",\n\t\t\t\"description\": \"Enter full details of your problem\",\n\t\t\t\"type\": \"long_text\",\n\t\t\t\"validation\": {\n\t\t\t\t\"required\": true\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_domain}}/v1/doctor/forms","description":"You can use Predefine fields for: full_name, gender, born_date, reasons and chief_complaint like this:
\"fields\": [\n {\"pre_define\": \"full_name\"},\n {\"pre_define\": \"chief_complaint\"},\n {\n \"order\": 3,\n \"title\": \"Result of complete check-up test\",\n \"type\": \"file\",\n \"validation\": {\n \"required\": false\n }\n }\n]\n\n