Using Pimatic API

romulus

Hello,
I have a problem using the Pimatic API. Firstly I try to get the Informations to a special device, in this case a switch. In the browser (Firefox) I’ve entered “https://<pimatic URL>/api/devices/schiefelampe” and get the JSON Object of the switch device back.

However, if I send this via curl with the following command:

curl -X GET https://<USER>:<PASSWORD>@<pimatic URL>/api/devices/schiefelampe

I only get the following error message:

TypeError: Cannot read property ‘set’ of undefined
at unauthorized (/opt/pimatic-app/node_modules/pimatic/lib/framework.coffee:336:14)
at /opt/pimatic-app/node_modules/pimatic/lib/framework.coffee:357:11
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at _cookieSession (/opt/pimatic-app/node_modules/pimatic/node_modules/cookie-session/index.js:124:5)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at jsonParser (/opt/pimatic-app/node_modules/pimatic/node_modules/body-parser/lib/types/json.js:103:7)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at urlencodedParser (/opt/pimatic-app/node_modules/pimatic/node_modules/body-parser/lib/types/urlencoded.js:91:7)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at cookieParser (/opt/pimatic-app/node_modules/pimatic/node_modules/cookie-parser/index.js:56:14)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at /opt/pimatic-app/node_modules/pimatic/lib/framework.coffee:261:9
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at /opt/pimatic-app/node_modules/pimatic/node_modules/connect-timeout/index.js:64:5
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at expressInit (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/middleware/init.js:33:5)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at query (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/middleware/query.js:44:5)
at Layer.handle [as handle_request] (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:312:13)
at /opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:280:7
at Function.process_params (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:330:12)
at next (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:271:10)
at Function.handle (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/router/index.js:176:3)
at EventEmitter.handle (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/application.js:173:10)
at Server.app (/opt/pimatic-app/node_modules/pimatic/node_modules/express/lib/express.js:38:9)
at emitTwo (events.js:87:13)
at Server.emit (events.js:172:7)
at HTTPParser.parserOnIncoming [as onIncoming] (_http_server.js:533:12)
at HTTPParser.parserOnHeadersComplete (_http_common.js:103:23)

I really have no Idea what I’m doing wrong in the CURL command.

mwittig

Try

curl -X GET --user "user:password" https://XXX.XXX.XXX.XXX/api/devices/schiefelampe

If you use a certicate created by a self-signed CA you may also need to add option -k

EDIT:

Can you please let me know which version of pimatic you’re using as I am not able to reproduce the TypeError.

romulus

Hi,
This command I’ve also tried, it the first I’ve tried, because this is how it’s documented

A self signed CA is also not in use, I use let’s encrypt.

I’m currently using Version 0.9.34:

pimatic-daemon.log:11:00:20.144 [pimatic] info: Starting pimatic version 0.9.34

There doesn’t seem any newer Version to be available.

mwittig

@romulus Thanks.

Meanwhile, I managed to reproduce the error which occurs if a wrong username or password is provided.
It should work though if you provide the correct credentials.

https://github.com/pimatic/pimatic/issues/1002

romulus

Ok, it’s a bit more complicated, because I’ve used the correct credentials.

I’ve also tested a bit more, in found the following issue:

With my user who has the role “admin” I get the error from before.

With another User who has the Role “user”, the API call via Curl worked. For me it looks like a user who has to much rights isn’t able to use the API, may for security purposes?

Here the Roles:

“roles”: [
{
“name”: “admin”,
“permissions”: {
“pages”: “write”,
“rules”: “write”,
“variables”: “write”,
“messages”: “write”,
“events”: “write”,
“devices”: “write”,
“groups”: “write”,
“plugins”: “write”,
“updates”: “write”,
“database”: “write”,
“config”: “write”,
“controlDevices”: true,
“restart”: true
}
},
{
“name”: “user”,
“permissions”: {
“pages”: “read”,
“rules”: “read”,
“variables”: “read”,
“messages”: “read”,
“events”: “read”,
“devices”: “read”,
“groups”: “read”,
“plugins”: “read”,
“updates”: “read”,
“database”: “read”,
“config”: “read”,
“controlDevices”: true,
“restart”: false
}
}

romulus

Autch shit… it was a stupid fault from my side! My Password contains some special characters and here was the issue! After I’ve terminated them with a backslash, i worked!

So stupid, sorry to disturbed you!

Romulus

mwittig

@romulus said in Using Pimatic API:

So stupid, sorry to disturbed you!

No worries, as it revealed another bug - fixture in progress