nytimes/elemental-live-client

JS library to communicate with Elemental live API.

elemental-live-client's Issues

input preview request is not hitting the right api endpoint

we should use the /generate_preview for preview inputs, the same way the UI does. This way we'll receive errors when trying to generate preview of inputs being used in transmissions. I don't know if the /generate_preview endpoint is documented but I could see some interesting stuff on their routes.rb file.

I'll try to work on this and submit a PR.

publish this lib on npm

support REST authentication on the client

some extra headers needed to be passed if the api endpoint is not entirely open:

Authentication and REST
When authentication is enabled on the Elemental Live system, additional information must be sent with the REST command in order to properly authenticate the request. The following additional headers must be set: X-Auth-User, X-Auth-Expires, X-Auth-Key.

The X-Auth-User header contains the login of the user to authenticate.

The X-Auth-Expires header contains the Unix timestamp (in UTC) that indicates the time after which the server will no longer accept the request as valid. For security purposes, Elemental recommends that this value should be ~30 seconds in the future.

The X-Auth-Key header should be constructed using the following algorithm:

md5(api_key + md5(url + X-Auth-User + api_key + X-Auth-Expires))

Trying to list down elemetal channels

Hi,

Thanks in Advance! Could you please provide proper documents on how we can use api_key and server_ip in code and how to use it in js.

-Kiran