Management API

intro this is the api documentation for the intelliprove management api , which allows you to perform management operations such as requesting reminaing quota prerequisites if you are new to this developer portal, we recommend first reading the plug in overview docid\ fwrilxhap81oojwmwf3tr , a five minute read which will get you acquainted with how our plug in works and how it can be integrated into your platform to integrate the plug in into your platform, follow our plug in docid\ f86cembkuj kwr60rtrev documentation setup environments as a customer, you will receive information about the environment (api base url) to use for development and production authentication all the endpoints described below require an api key or a bearer token in the header for authentication purposes api key an api key forms a permanent access key to authenticate with the api your api key should never be exposed in your front end and only be used on protected servers and back end systems api keys are sent in the header of the request x api key \<your api key> no api key and interested in our product? contact us (info\@intelliprove com) or set up a call auth endpoints { "tab" "examples", "url" "https //engine intelliprove com/v1/auth/me", "name" "get user details", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "cft83wo amnab1owrl4uf", "code" "{\n \\"email\\" \\"sales\@intelliprove com\\",\n \\"customer\\" \\"intelliprove\\",\n \\"group\\" \\"contributor\\"\n}", "language" "200", "customlabel" "" }, { "id" "56xj74pxh2owc4yubp9di", "code" "{\n \\"status\\" 403,\n \\"reason\\" \\"missing or invalid authentication credentials \\"\n}", "language" "403", "customlabel" "" } ], "selectedlanguageid" "56xj74pxh2owc4yubp9di" }, "examples" { "languages" \[ { "id" "xkjmjni8uojnfn3xysv2y", "code" "curl location 'https //engine intelliprove com/v1/auth/me' \\\\\n header 'accept application/json' \\\\\n header 'x api key your api key'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "xkjmjni8uojnfn3xysv2y" }, "description" "use this endpoint to retrieve user information for the current user the user information defines to which user group and customer you belong ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //engine intelliprove com/v1/auth/action token", "name" "create action token", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "expire in", "type" "integer", "description" "lifetime of the token in seconds defaults to 6 hours, maximum 12 hours " }, { "kind" "optional", "name" "meta", "type" "object", "children" \[], "description" "custom metadata to place in the action token " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "kctn4gzlot sdn t cyop", "code" "{\n \\"token\\" \\"eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9 eyj1c2vyijp7imvtywlsijoiiiwiy3vzdg9tzxiioij0zxn0aw5nlwfwas1rzxkilcjncm91cci6imfkbwluiiwibwf4x21lyxn1cmvtzw50x2nvdw50ijotmx0sim1ldgeiont9lcjlehaioje2odu2nte1otl9 uwoflwbiwuvlxfpmzvg3plret1q 9vbzf1xnfpuktc0\\"\n}", "language" "201", "customlabel" "" }, { "id" "vqaujlfnmcvrfr9b6w1ei", "code" "{\n \\"status\\" 401,\n \\"reason\\" \\"missing or invalid authentication credentials \\"\n}", "language" "401", "customlabel" "" }, { "id" "uxlmhgeywdnh1p9chadk ", "language" "500", "code" "{\n \\"status\\" 500,\n \\"reason\\" \\"could not create new action token\\"\n}", "customlabel" "" } ], "selectedlanguageid" "kctn4gzlot sdn t cyop" }, "examples" { "languages" \[ { "id" "s0mcduwkinbnrg9pa thb", "code" "curl location 'https //engine intelliprove com/v1/auth/action token' \\\\\n header 'content type application/json' \\\\\n header 'x api key your key' \\\\\n data '{\n \\"expire in\\" 2592000,\n \\"meta\\" {}\n}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "s0mcduwkinbnrg9pa thb" }, "description" "create a new action token with optional custom lifetime and custom metadata do not place confidential information in the metadata object \nthis endpoint can only be called with an api key ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //engine intelliprove com/v1/patient/data", "name" "delete patient data", "method" "delete", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "optional", "name" "patient ref", "type" "string", "children" \[], "description" "patient for which the health checks are to be deleted " }, { "kind" "optional", "name" "performer ref", "type" "string", "children" \[], "description" "additional filter on performer reference " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bg9pqckwqxzbo5auenqtz", "code" "", "language" "202", "customlabel" "" }, { "id" "y8vii vsoxsubbv9jx np", "code" "{\n \\"detail\\" \\"please provide a patient reference \\"\n}", "language" "400", "customlabel" "" }, { "id" "qtlauc1mj gm4vfvhl0eh", "language" "403", "code" "{\n \\"detail\\" \\"provided patient is not allowed \\"\n}", "customlabel" "" } ], "selectedlanguageid" "qtlauc1mj gm4vfvhl0eh" }, "examples" { "languages" \[ { "id" "os4e3jeuplsboxgcvxqdg", "code" "curl location request delete 'https //engine intelliprove com/v1/patient/data?patient ref=your patient ref\&performer ref=your performer ref' \\\\\n header 'x api key your api key'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "os4e3jeuplsboxgcvxqdg" }, "description" "delete all results for a specific patient ", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } account endpoints { "name" "get quota", "method" "get", "url" "https //engine intelliprove com/v1/account/quota", "description" "receive information abour your quota and current usage ", "tab" "examples", "examples" { "languages" \[ { "id" "gle 59oy3czqvmz78ns1q", "language" "curl", "code" "curl location 'https //engine intelliprove com/v1/account/quota' \\\\\n header 'x api key your api key'", "customlabel" "" } ], "selectedlanguageid" "gle 59oy3czqvmz78ns1q" }, "results" { "languages" \[ { "id" "dp tooukgypxpbotgfpbc", "language" "200", "customlabel" "", "code" "{\n \\"performed measurements\\" 0,\n \\"quota\\" 10000,\n \\"period start\\" \\"2023 06 01t00 00 00\\",\n \\"period stop\\" \\"2023 07 01t00 00 00\\",\n \\"usage percentage\\" 0 0\n}" }, { "id" "qinwm vi03fmn4naqdgq ", "language" "403", "customlabel" "", "code" "only admins are allowed to use this request" }, { "id" "p6okyp5sebtmzucdcxlmf", "language" "401", "code" "{\n \\"detail\\" \\"missing or invalid authentication credentials \\"\n}", "customlabel" "" } ], "selectedlanguageid" "p6okyp5sebtmzucdcxlmf" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } regulatory endpoints { "name" "get ce label", "method" "get", "url" "https //engine intelliprove com/v1/regulatory/ce label", "description" "request the intelliprove medical device label", "tab" "examples", "examples" { "languages" \[ { "id" "gle 59oy3czqvmz78ns1q", "language" "curl", "code" "curl location 'https //engine intelliprove com/v1/regulatory/ce label'", "customlabel" "" } ], "selectedlanguageid" "gle 59oy3czqvmz78ns1q" }, "results" { "languages" \[ { "id" "dp tooukgypxpbotgfpbc", "language" "200", "customlabel" "", "code" "// returns the medical device label as png file" } ], "selectedlanguageid" "dp tooukgypxpbotgfpbc" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } refer to our instructions for use docid\ jmsmbxwfyqbsttsluvw00 for more information related to our medical device's product description and intended use