Refinitiv / websocket-api

A direct access WebSocket API that enables easy integration into a multitude of client technology environments such as scripting and web.
Other
68 stars 40 forks source link

Remove / reduce the confusion between username and MachineID #15

Closed umernalla closed 2 years ago

umernalla commented 3 years ago

We are still getting customers who are using their username (e.g. corporate email address) for the --user parameter when running the examples - leading to frustration, time waste all around and a very poor introductory experience of Refinitiv.

This is despite Quickstarts, RTO guides and Welcome Emails etc mentioning that MachineID is required for programmatic access to data.

In view of this can we change the README and examples to mention MachineID. Ideally, even show a dummy machineID so that there remains no doubt. e.g. in code user = 'GE-A-001234545-1-1234' // Replace with your Machine ID

and on the README page:

--user | REQUIRED. MachineID to use when authenticating to Refinitiv Data Platform. -- | --

OR even better change the parameter name to MachineID

vlevendel commented 3 years ago

Thank you for bringing this up. We'll do the needful after confirmation.

vlevendel commented 2 years ago

Fixed in documentation.