Request plug-in URL

intro to integrate the plug in within your website or mobile app, you will need a temporary authenticated url example https //plugin intelliprove com?action token=\<action token>\&patient=\<patient> validity the action token embedded in the url has a fixed expiry time currently, this is set to 6 hours, meaning the url will no longer be valid after that a new temporary url should be requested after expiring prerequisites if you haven't already, go through our web plug in overview docid\ fwrilxhap81oojwmwf3tr to get a clear understanding of the plug in flow and its features request url requesting a temporary web plug in url can be done with a simple http get call to the intelliprove api please note that this step requires a valid intelliprove api key exposing this api key to the client side is bad practice you should not incorporate the api key in your js browser code instead, resolve the plug in url from a backend server name get temporary plug in url method get url https engine intelliprove com v1 plugin make description tab examples examples languages id vdsinht1h1g3yuqbzuqyh language curl code curl https engine intelliprove com v1 plugin make?apikey your api key customlabel selectedlanguageid vdsinht1h1g3yuqbzuqyh results languages id ef0sgkvntwe2wdwshdiif language 200 customlabel code https plugin intelliprove com?action token eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9 eyj1c2vyijp7imvtywlsijoiiiwiy3vzdg9tzxiioij0zxn0aw5nlwfwas1rzxkilcjncm91cci6inn1cgvylwfkbwluiiwibwf4x21lyxn1cmvtzw50x2nvdz50ijoxmdawmh0sim1ldgeiont9lcjlehaioje3mde4mja4mdb9 cmvqcq2yfufk6ovnlbmqcw6eoc3cnjltyr4ouygdvde language en id gttopuuxfeohi3fbz9mzm language 403 code n reason missing or invalid authentication credentials n customlabel selectedlanguageid ef0sgkvntwe2wdwshdiif request pathparameters queryparameters name apikey kind optional type string description customer api key children name language kind optional type string description set a language for the plug in default is english when not given children name performer ref kind optional type string description performer reference for the measurement children name patient ref kind optional type string description patient reference for the measurement children headerparameters bodydataparameters formdataparameters currentnewparameter label query parameter value queryparameters please be aware that the url provided in the response is subject to change this involves not just the action token part, which varies with each new request, but also the subdomain of the url, which may change when new versions of the plugin are released consequently, make sure not to hardcode any elements of this url instead, consistently utilize the entire response url as obtained additional query parameters the web plug in url allows adding additional session parameters via query parameters these parameters are not mandatory but are recommended for enhanced functionality language specify the language to allow the web plug in to default to your preferred locale the language code should consist of a two letter language code the currently supported languages are "en" ( english , default) and "nl" ( dutch ) please contact us if other languages should be supported patient ref recommended add a unique reference to track which user ('patient') was been measured this allows us to keep track of previous health scans of the patient and use these for long term health trends take into account that this is required to obtain an outcome for the mental health risk docid\ m81stnwaivxts8hsvocxt parameter make sure the 'patient reference' is a hashed, pseudonymized reference! an example is provided here performer ref add a unique reference to track who performed each measurement this allows you to group measurements performed by a specific health professional or at a specific location on your website when to request the url? it's a good practice to request a new url for every new session initiated, i e , every new end user logging into your platform for each new session, ensure to request a new url via our api, and include the user's id in the patient ref query parameter once generated, the same url can be used for the same user for up to 6 hours, after which a new request will be necessary you can paste the obtained url in your browser to play with the health scan and show off a first poc! next steps now, that you understand how to request the plug in url, it's time to embed the plug in component in your app continue with the embed plug in docid\ vywpzgyzobqqswusjqy 4 documentation