node-red-contrib-ninox

A Node-RED node to Ninox API.

Install

Needs curl installed on node-red host.

Run the following command in the root directory of your Node-RED install

npm install node-red-contrib-ninox

Usage

Please see the node's info inside node-red web interface.

IMPORTANT: Be sure to remove the API key when sharing / exporting your flow!

Example

[{"id":"e8122878.4eeab8","type":"tab","label":"Ninox Demo","disabled":false,"info":""},{"id":"b6d5b527.881188","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"all","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":730,"y":140,"wires":[["bf4da4d9.4297d8"]]},{"id":"bf4da4d9.4297d8","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":140,"wires":[]},{"id":"2e2245f9.f10ada","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":140,"wires":[["b6d5b527.881188"]]},{"id":"609dae40.fa8fd","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":200,"wires":[["5e3a6f1c.f19c3"]]},{"id":"58de01ac.450e1","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"one","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":730,"y":200,"wires":[["69351c5b.13af34"]]},{"id":"69351c5b.13af34","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":200,"wires":[]},{"id":"5e3a6f1c.f19c3","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.payload = 3725;\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":200,"wires":[["58de01ac.450e1"]]},{"id":"6b8cc7a2.2a0538","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":260,"wires":[["eb592939.6aad28"]]},{"id":"eb592939.6aad28","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"find","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":730,"y":260,"wires":[["7b98f3f7.1f217c"]]},{"id":"7b98f3f7.1f217c","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":260,"wires":[]},{"id":"dc84f0fd.c7854","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":320,"wires":[["386dff34.5991f"]]},{"id":"981d9079.7f44a","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"save","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":730,"y":320,"wires":[["f6efbf64.f70b5"]]},{"id":"f6efbf64.f70b5","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":320,"wires":[]},{"id":"386dff34.5991f","type":"function","z":"e8122878.4eeab8","name":"set values for insert / update","func":"msg.payload = [{\n    id: 3725,\n    fields: {\n        \"Betreff\": \"moin\"\n    }\n}, {\n    fields: {\n        \"betreff\": \"Bonjour\"\n    }\n}];\nreturn msg;","outputs":1,"noerr":0,"x":460,"y":320,"wires":[["981d9079.7f44a"]]},{"id":"c10a94d2.3670b8","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"delete","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":740,"y":380,"wires":[["d58da7f9.d80d38"]]},{"id":"d58da7f9.d80d38","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":380,"wires":[]},{"id":"7ee52ad5.4541e4","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":380,"wires":[["8122f033.815ab"]]},{"id":"8122f033.815ab","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.payload = 3723;\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":380,"wires":[["c10a94d2.3670b8"]]},{"id":"c2df184.f3fffe8","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"allfiles","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":740,"y":440,"wires":[["99dd0a0e.3d6378"]]},{"id":"99dd0a0e.3d6378","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":440,"wires":[]},{"id":"3e83b357.a7804c","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":440,"wires":[["b297c02b.dfbde"]]},{"id":"b297c02b.dfbde","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.payload = 3725;\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":440,"wires":[["c2df184.f3fffe8"]]},{"id":"e1cdda3d.e4a288","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"onefile","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":740,"y":500,"wires":[["6dbbe68.b591b18"]]},{"id":"b61c1831.05e258","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.nid = 3725;\nmsg.filename = \"Ticket3725.pdf\";\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":500,"wires":[["e1cdda3d.e4a288"]]},{"id":"7fbdd2f8.bf9a6c","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":500,"wires":[["b61c1831.05e258"]]},{"id":"5b2a0972.b12e18","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":1570,"y":500,"wires":[]},{"id":"f2502aee.6f3118","type":"file in","z":"e8122878.4eeab8","name":"open temp file","filename":"","format":"","chunk":false,"sendError":false,"x":1340,"y":500,"wires":[["5b2a0972.b12e18","ba32e0a.db5b92"]]},{"id":"6dbbe68.b591b18","type":"function","z":"e8122878.4eeab8","name":"prepare to open downloaded tempfile","func":"msg.filename = msg.pathname;\nreturn msg;","outputs":1,"noerr":0,"x":1050,"y":500,"wires":[["f2502aee.6f3118"]]},{"id":"c78e9c9b.ad9b6","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"uploadfile","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":750,"y":560,"wires":[["e0a3a299.4c3ab"]]},{"id":"ba32e0a.db5b92","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.nid = 3726;\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":560,"wires":[["c78e9c9b.ad9b6"]]},{"id":"e0a3a299.4c3ab","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":947,"y":557,"wires":[]},{"id":"d4cd6ac1.c40098","type":"ninox action","z":"e8122878.4eeab8","name":"","method":"deletefile","config":"78d3eb21.005334","database":"ku6zsi56wr2t","databasename":"Tickets","table":"A","tablename":"Ticket","types":[{"id":"A","name":"Betreff","type":"string"},{"id":"B","name":"Text","type":"string"},{"id":"C","name":"E-Mail","type":"email"},{"id":"D","name":"Eingang","type":"date"}],"map":[],"x":750,"y":620,"wires":[["9d4cad87.580f"]]},{"id":"9d4cad87.580f","type":"debug","z":"e8122878.4eeab8","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":950,"y":620,"wires":[]},{"id":"3697d4fe.f5d6dc","type":"inject","z":"e8122878.4eeab8","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":240,"y":620,"wires":[["f72c2ab9.f6e018"]]},{"id":"f72c2ab9.f6e018","type":"function","z":"e8122878.4eeab8","name":"set nxid","func":"msg.nid = 3725;\nmsg.filename = \"Ticket3725.pdf\";\nreturn msg;","outputs":1,"noerr":0,"x":440,"y":620,"wires":[["d4cd6ac1.c40098"]]},{"id":"78d3eb21.005334","type":"ninox-config","z":"","name":"","host":"api.ninoxdb.de","port":"443","apiversion":"v1","apikey":"9f9363c0-8380-11e9-9228-afbd800e8458","publicprivate":true,"team":"jEJEXT8QRxzwp7NZK","teamname":"test","teamselect":"jEJEXT8QRxzwp7NZK"}]

Acknowledgements

Loosely oriented along node-red-contrib-ftp sources.

License

See [license] (https://gitlab.com/kurvenschubser1/node-red-contrib-ninox/blob/master/LICENSE) (Apache License Version 2.0).