In order to authenticate with the service, you will need to call the following endpoint:

Size: px

Start display at page:

Download "In order to authenticate with the service, you will need to call the following endpoint:"

Julie Montgomery
5 years ago
Views:

1 API Izum Izum s API is a RESTful based web service, available at In rder t use the API yu will need t have an Izum accunt, sign in n ur web app ( g t yur prfile and create na API key. This key will be used t authenticate with the service s yu can get a temprary sessin tken that will allw yu t execute all ther methds. Authenticatin In rder t authenticate with the service, yu will need t call the fllwing endpint: /auth Input Parameters (JSON frmat in Request Paylad): apikey Example: { "": "hell@izum.i", "apikey" : "Th8bcehNzvgVzfGl2gKdK8nxUf0tpqcGIAXEl9FS } This methd, like all thers, will return a respnse als in JSON frmat, that will include a success r errr indicatr and a sessin tken. This sessin tken will be used t invke all remaining methds and will expire after tw hurs. When the sessin tken expires yu will need t call the authenticatin methd again t retrieve a new sessin tken. Registering yur wn device type Besides wrking with Izum devices, the Izum structure can als supprt ther types f devices, such as smartphnes r ther IT devices. If yu wish t add a new device type and specific types f sensrs t ur list, please cntact us at hell@izum.i. If apprved, yu will receive a device type ID and sensr ID that yu will be able t use t feed data t ur platfrm. Invking Methds Methds can be invked in tw ways: yu will either pass input parameters as a JSON request paylad, just like in the /auth methd abve (fr HTTP verbs such as POST r PUT), r input parameters can simple be passed as part f the URL (fr HTTPS verbs such as GET r DELETE).

2 With the exceptin f the authenticatin methd, all methds will always need at least the and sessin key as input. The respnse fr all methds will always be in JSON frmat, and will include an utput parameter indicating whether the call was successful r nt. This parameters is called cde and will return 1 fr a successful peratin, and 0 if sme srt f errr ccurred. The URL fr all methd is the base API URL fllwed by the endpint f each methd. Example: Methd List /accunt/alert/check sessin Descriptin: Returns whether the current accunt has a device in an alert state r nt /accunt/alert/list sessin Descriptin: JSON list f current alerts in all f the user's devices /accunt/alert/listv2 sessin sensrid (ptinal) (ptinal) histry (blean, ptinal) Descriptin: List the current alerts, ptinally fr a particular sensr, acrss ne r multiple devices. Can als display histry including readings that are nt alerts.

3 /device/{} HTTP Verb: DELETE sessin passwrd Descriptin: Delete device frm yur IZUM accunt. /device/{}/batteryvalue sessin value (0-100%) state (ptinal) Descriptin: Input device battery state (fr nn-izum devices) /device/{}/calibrateprximity sessin tlerance (0-100%) Descriptin: Sets prximity sensr based n last values read frm that specific sensr. Minimum value will be last value minus tlerance, maximum will be last value plus tlerance. /device/{}/check sessin

4 Descriptin: Checks if the device is in an alert state r nt. /device/{}/delaypush sessin sensrid (ptinal) minutes (ptinal, default 15) Descriptin: Executing this methd will prevent push ntificatins frm being sent fr respective accunt and device. Optinally push ntificatins can be temprarily disabled fr ne sensr nly. /device/{}/dnd/add sessin days start_time end_time Descriptin: Adds d nt disturb perid fr the device that will be applied frm start_time t end_time fr the chsen days (IZUM devices nly). /device/{}/dnd/list sessin Descriptin: Lists d nt disturb perids fr chsen device (IZUM devices nly). /device/{}/dnd/remve HTTP Verb: DELETE

5 sessin passwrd muteid unmuteid Descriptin: Remves d nt disturb perid fr the device with muteid and unmuteid (IZUM devices nly). /device/{}/dnd/update sessin days muteid unmuteid start_time end_time Descriptin: Updates d nt disturb perid fr the device based n muteid and unmuteid that will be applied frm start_time t end_time fr the chsen days (IZUM devices nly). /device/{}/histry sessin limit (ptinal) datestart (ptinal) dateend (ptinal) firsttlast (ptinal, blean) sensrid (ptinal) Descriptin: Lists the histry f sensr readings accrding t filters given as input.

6 /device/{}/lad sessin Descriptin: Lads the device s sensrs and settings. /device/{}/ladsensr sessin sensrid Descriptin: Lads the device s sensr settings. /device/{}/ff sessin Descriptin: Sends message t turn ff device (IZUM devices nly). /device/{}/n sessin Descriptin: Sends message t turn n device (IZUM devices nly). /device/{}/tgglepush

7 sessin Descriptin: Switches whether push ntificatins are being sent frm the device r nt. /device/{}/tgglepushsensr sessin sensrid Descriptin: Switches whether push ntificatins are being sent frm the device s selected sensr r nt. /device/{}/schedule/add sessin days start_time end_time Descriptin: Adds perating schedule fr the device that will be applied frm start_time t end_time fr the chsen days (IZUM devices nly). /device/{}/schedule/list sessin Descriptin: Lists perating schedules fr chsen device (IZUM devices nly). /device/{}/schedule/remve

8 HTTP Verb: DELETE sessin passwrd activateid deactivateid Descriptin: Remves perating schedule fr the device with activateid and deactivateid (IZUM devices nly). /device/{}/schedule/update sessin days activateid deactivateid start_time end_time Descriptin: Updates perating schedule fr the device based n activateid and deactivateid that will be applied frm start_time t end_time fr the chsen days (IZUM devices nly). /device/{}/sensr/read sessin sensrid Descriptin: Get latest value read frm respective sensr f respective device. /device/{}/sensr/sensralertmessage

9 sessin sensrid message type Descriptin: Sets alert message fr chsen sensr and device, type will define if the message is generic, fr minimum threshld f maximum threshld, functinality will depend n the sensr. /device/{}/sensr/sensrset sessin idtype active peridicity (ptinal) alertactive (ptinal, blean) minvalue maxvalue alertled (ptinal, blean) alertpush (ptinal, blean) alertmessage (ptinal) alertmessagelw (ptinal) alertmessagehigh (ptinal) Descriptin: Sets all ptins fr sensr cnfiguratin, idtype is equivalent t sensrid in ther methds. /device/{}/sensr/sensrvalue sessin idtype value

10 alert (ptinal, blean) message (ptinal) Descriptin: Fr nn Izum devices, sends values read by sensr t ur platfrm, allwing t indicate if it s an alert and what message it shuld give t the user. /device/create sessin iddevicetype serialnumber name idtimezne (ptinal) Descriptin: Inserts nn IZUM device in database, serialnumber shuld be unique identifier and device type shuld be the ID prvided by us after cntacting us t allw fr new types t wrk with ur platfrm. /device/getid sessin serial Descriptin: Get Device ID based n serial number. /device/list sessin devicetype (ptinal) Descriptin: Get list f user s devices.

11 /device/listall sessin devicetype (ptinal) Descriptin: Get list f user s devices, including devices user was invited t mnitr nly /device/listlimited sessin devicetype (ptinal) Descriptin: Get list f device user is mnitring as a guest nly. /device/update sessin iddevicetype serialnumber name idtimezne (ptinal) realtime (ptinal, blean) Descriptin: Updates device, allwing t set device t cmmunicate in real time, fr IZUM devices nly. /hme

12 sessin (ptinal) Descriptin: Get dashbard status either fr user accunt f just a specific device. /lcatin/{} sessin lnglat (ptinal, blean) allws usage f Latitude Lngitude frmat r Lngitude, Latitude frmat. Descriptin: GeJSON Feature cntaining last knwn lcatin f the device. /lcatin/{}/sensrvalue sessin latitude lngitude altitude (ptinal) hr_accuracy (ptinal) vert_accuracy (ptinal) bearing (ptinal) speed (ptinal) Descriptin: Fr nn Izum devices, sends values read by lcatin sensr t ur platfrm. /lcatins/{}

13 sessin limit lnglat (ptinal, blean) allws usage f Latitude Lngitude frmat r Lngitude, Latitude frmat. Descriptin: GeJSON Feature cllectin cntaining last <limit> lcatins f the device. /tables/cuntry sessin Descriptin: Lists cuntries in ur database. /tables/sensrtype sessin Descriptin: Lists sensr types in ur database, t use fr sensrid r idtype parameters. /tables/timezne sessin Descriptin: Lists time znes available in ur database. /zne

14 sessin latitude lngitude radius descriptin (ptinal) alert_in (blean) alert_ut (blean) Descriptin: Creates gefence zne assciated with device /zne/{zneid} HTTP Verb: DELETE sessin zneid Descriptin: Delete zne frm yur device. /zne/{zneid}/check sessin zneid latitude lngitude Descriptin: Verifies whether given psitins shuld cause an alert fr selected zne /zne/{zneid}/update sessin

15 zneid latitude lngitude radius descriptin (ptinal) alert_in (blean) alert_ut (blean) Descriptin: Updates zne s data. /znes/{} sessin Descriptin: Lists gefence znes assciated with device. Additinal Infrmatin Weekdays is a data type that shuld be prvided in the fllwing frmat: { mnday : true false, tuesday : true false, wednesday : true false, thursday : true false, friday : true false, saturday : true false, sunday : true false, } There is a special sensr ID type fr battery (99), ther sensr types include: 1. Light 2. Temperature 3. Humidity

16 4. Prximity 5. Accelermeter 6. Gyrscpe 7. Lcatin (GPS) 8. Mvement 9. Magnetic

How to use DCI Contract Alerts

How to use DCI Contract Alerts Hw t use DCI Cntract Alerts Welcme t the MyDCI Help Guide series Hw t use DCI Cntract Alerts In here, yu will find a lt f useful infrmatin abut hw t make the mst f yur DCI Alerts which will help yu t fully