Clarify requirements for Logi Circle redirect URIs (#9393)

* Clarify requirements for Logi Circle redirect URIs

Logitech impose strict requirements on redirect URIs when requesting API access, I’ve updated the docs to include these requirements and replaced the example URL with a Nabu Casa URL since the original .local example is invalid.

* Minor changes
This commit is contained in:
Evan Bruhn 2019-05-06 16:24:51 +10:00 committed by Fabian Affolter
parent 2dd1d58849
commit c5342b3be6

View File

@ -33,7 +33,10 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http
* `circle:notifications` * `circle:notifications`
* `circle:summaries` * `circle:summaries`
4. Request the `authorization_code` grant type. 4. Request the `authorization_code` grant type.
5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://homeassistant.local`, then request `https://homeassistant.local/api/logi_circle`. The redirect URI _must_ be HTTPS. 5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
* The URL must be HTTPS with a SSL certificate issued by a trusted CA (i.e., trusted by normal browsers).
* At the time you submit your request to Logitech, you need to demonstrate that you have exclusive control of the fully qualified domain name in your redirect URI. An active Home Assistant instance at the redirect URI will suffice. If you don't want to expose your Home Assistant instance publicly, you may also place a static page at the redirect URI with a short message that you will manage redirection of the authorization token to your local Home Assistant instance. Free static hosts that issue subdomains for hosting (e.g., Netlify) are permitted.
* As the redirect URI must be public facing, no local/reserved TLDs are permitted (eg. .local, .localhost, .example, etc. are not allowed).
Please note that the turn-around time for API access takes a few business days after which you will be contacted by Logitech using the email address you provided in the form. Please note that the turn-around time for API access takes a few business days after which you will be contacted by Logitech using the email address you provided in the form.