search

homebridge / homebridge-config-ui-x

The Homebridge UI. Monitor, configure and backup Homebridge from a browser.
https://homebridge.io
MIT License
2.61k stars 373 forks source link

API Questions #860

Closed C4Wiz closed 4 years ago

C4Wiz commented 4 years ago

Describe Your Problem:

i am trying to create a bitbar plugin for the HomeBridge UI, i don't quite understand the url requests.

how are they formed with username and pass? Logs:

Show the Homebridge / Homebridge Config UI X logs here.

Homebridge Config:

Show your homebridge config.json here

Screenshots:

Environment:

oznu commented 4 years ago

Calling POST /api/auth/login with a valid username and password will return an authentication token, use this in subsequent requests by adding as a HTTP header: Authorization: Bearer xxxxxxxxxxxxx.

See the Swagger page - https://github.com/oznu/homebridge-config-ui-x/wiki/API-Reference - when testing endpoint you will see how the request is formed using curl which you should be able to translate into your language of choice.

C4Wiz commented 4 years ago

yea i read the api docs.

there are no examples in it.

you copying and pasting from the api pages is of 0 help to me

rpolenthon commented 4 years ago

@C4Wiz You have full examples in the source code of UIX ;)

Even if there would be a few more examples for the API, you still would have to look into the source code. There are sometimes specific cases that need to be covered, for which you need to understand what's happening under the hood.

However, I recommend you to use a tool to simulate the requests. I use Paw for that, but Postman is also a nice solution. This gives you a better and quick overview of the requests and you can play with them.

C4Wiz commented 4 years ago

Calling POST /api/auth/login with a valid username and password will return an authentication token, use this in subsequent requests by adding as a HTTP header: Authorization: Bearer xxxxxxxxxxxxx.

See the Swagger page - https://github.com/oznu/homebridge-config-ui-x/wiki/API-Reference - when testing endpoint you will see how the request is formed using curl which you should be able to translate into your language of choice.

so them how is "http://homebridge.local:8581/api/status/homebridge" formatted with the token auth?

oznu commented 4 years ago

You set it as a header.

GET http://homebridge.local:8581/api/status/homebridge
Authorization: Bearer auth-token-here

Or with curl:

curl -H "Authorization: Bearer auth-token-here" http://homebridge.local:8581/api/status/homebridge
C4Wiz commented 4 years ago

sorry im new to this, here is my code for bitbar:

import json
import os
import urllib2

try:  # Python 3
    from urllib.request import urlopen
except ImportError:  # Python 2
    from urllib2 import urlopen  # noqa

# URL to the Homebridge UI
base_url = "http://homebridge.local:8581"

# Url to check the service status
url_status = "/api/status/homebridge"

def separator():
    print('---')

#menubar icon
print "| image=iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAFo9M/3AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAABGBJREFUeAEAEgDt/wD2yksA/8cN8gD/zCHy/dtv/wAAAP//ABIA7f8A/8wl8v3MK+sA/eOS//7ijP8AAAD//wAiAN3/AP/MJPb+1lL//8YG//3jkf8A/swr9P3qtP/94Yn//eOR/wAAAP//AEQAu/8A+8squf/NJ/L/zCHy+Mk9SwD/zSX//tA1//7USf//zCH/AP7DAP/95qD//eSU///NJf8A/8QD//3hiP/9337//8wc/wAAAP//AIQAe/8A/Mosyf/MI///zSb//tNH//3uwv/922v//tZU///NGv8A/8wh8v7bav/+zSr//8gT///SPf//xAD//Oqv///IDv8A/8wh8v/GB//+2WD//ddd//3hg///xAr//eOU///MI/8A98lBPP/OHf//xwf//8cJ///HCP//xwn//8oR///LH/8ACAH3/gD4yT5H/cws6v/LIfL/xw3y/80n8v/MJPL7yiq69spLAAD/zRr//8wi///DAP/88Mr//dVS//3kl///yBL//MsrzwD/zCH//8MA//z02v//xQL//9RI//7SQv//xgf//8wl9gD/xw7//fDM//+/AP//0j3//8cP//7LIf/+3W///8wi8gD/zSX//eCF//3llv/92m3//eWa//3klf/+xAT//8wi8gD/zCP//eOR///ECP/+4ID//dda//7ZYP//xgb//8wi8gD/zBz//eKN//3fgP/94Yr//eCG//3qtP//xAL//swq9QD+yyD//8oQ///HCf//xwn//8cI///HBv//zh7/98lAQwAIAvf9APjJQUD/yx7//80a///MHP//zCH//80m///EAP/+1lH//tdW///EAP//xgj//8UB///ICP//zyH//8se//jJQEYA/cwr9f/MHf//zCL//80l///DAP/+1VD//fTY//7MJv/+yBf//fnz//3z1f/94Ib//eil///EAf//zBz//s0q9QD/zCHy/80m///DAP/+1VH//fPZ///QNP//xAD//8we///MHv//xwz//8EA//7eeP/95Zj//8AA///NJv//zCLyAP/KHPL/yBP//e7B//3wx//+yBH//tdZ//3hh//923X//dtz//3hiP/+2Fv//8gU//3vx//98Mr//8kV///KG/IA/8wi8v/MIv//xAD//eGI//7YXv/+zzj//OWc//3npf/956X//OWa//7OMv/+2WH//eKK///EAP//zCL//8wj8gD/zCX3/8wg///GBv/95Jb//tZX//+/AP//xgr//8AA///AAP//xgv//78A//7WWv/95Jr//8YG///MIP//zCX2APzKLMb/zRr//8oc///OLf/+2V///txs//7baP/+22j//tto//7baf/+3G7//tlf///PL///yhz//80a//3KK84A9spMAPfJPUH7yy2y/c0v5f7LJev+yyTp/ssl6f7LJen+yyXp/ssl6f7LJOn+zCbr/cwr4PvKKrT4yT1F9spMAAEAAP//VYsAVRgJj3cAAAAASUVORK5CYII="
separator()
print ("Open Homebridge UI | color=blue href=%s" % base_url)
separator()
print "HomeBridge Status: | color=silver"
request = urllib2.Request(base_url + '/api/status/homebridge')
response = urllib2.urlopen(request)
html = response.read()
print html + "| color=silver"
separator()
oznu commented 4 years ago

This may help: https://stackoverflow.com/a/7933546


request.add_header('Authorization', 'Bearer ' + auth-token-here)
C4Wiz commented 4 years ago

This may help: https://stackoverflow.com/a/7933546

request.add_header('Authorization', 'Bearer ' + auth-token-here)
print "HomeBridge Status: | color=silver"
request.add_header('Authorization', 'Bearer ' + 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwibmFtZSI6IkFkbWluaXN0cmF0b3IiLCJhZG1pbiI6dHJ1ZSwiaW5zdGFuY2VJZCI6ImQ3NDEzMmM4NmI3OGY3YWE1NGRjMzcwZmMwM2YwMGUyYTdjNWVjMTllMmVmYjk1NDdkNDk5NmE3NTdmMjcxZWIiLCJpYXQiOjE2MDE2NDczOTIsImV4cCI6MTYwMTY3NjE5Mn0.8woL7wj0Ni4js4KRJOdHRTK-rJfjo2DQ03voUfA00fA')
request = urllib2.Request(base_url + '/api/status/homebridge')
response = urllib2.urlopen(request)
html = response.read()
print html + "| color=silver"

returns:

Screen Shot 2020-10-02 at 11 10 55 AM
C4Wiz commented 4 years ago

This may help: https://stackoverflow.com/a/7933546

request.add_header('Authorization', 'Bearer ' + auth-token-here)

resolved above issue by swapping request.add_header and request order:

print "HomeBridge Status: | color=silver"
request = urllib2.Request(base_url + '/api/status/homebridge')
request.add_header('Authorization', 'Bearer ' + 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwibmFtZSI6IkFkbWluaXN0cmF0b3IiLCJhZG1pbiI6dHJ1ZSwiaW5zdGFuY2VJZCI6ImQ3NDEzMmM4NmI3OGY3YWE1NGRjMzcwZmMwM2YwMGUyYTdjNWVjMTllMmVmYjk1NDdkNDk5NmE3NTdmMjcxZWIiLCJpYXQiOjE2MDE2NDczOTIsImV4cCI6MTYwMTY3NjE5Mn0.8woL7wj0Ni4js4KRJOdHRTK-rJfjo2DQ03voUfA00fA')
response = urllib2.urlopen(request)
html = response.read()
print html + "| color=silver"

now to figure out how to convert {"status":"up"} to Running

also is it possible to get a token that does not expire?