Enact Data Receiver¶
The enact
data receiver connects to the Enact API for InfinityQS reads quality data available.
- Example:
{ "data_receiver": [ { "data_receiver_name": "enact_receiver0", "protocol": "enact", "connections": [{ "refresh_token": "...", "client_id": "...", "client_secret": "...", "subscription_key": "...", }], "streams": [] } ] }
Acquiring a refresh key is a crucial step in setting up the Enact REST API Receiver; annoyingly the provider is currently using a browser-redirect heavy workflow. In practice, that means you almost certainly want to use postman to fetch a refresh token: https://www.postman.com/downloads/
You can use the ‘get new authorization token’ button in the ‘Authorization’ header to get a new refresh token. This process needs to be done every 30 days when the existing refresh token expires.
Configuration:
Required and optional properties that can be configured for an Enact receiver:
data_receiver_name: Unique name of the data receiver. This name will be used to track the progress state of the data stream.
protocol: Protocol to be used. Should be set to
enact
.asset_tag: Column to use as the asset tag when not specified in the streams section.
default_stream_type: Stream type to used when not specified in the streams section.
connections: How to connect to the REST API. A connection has the following configurable settings:
refresh_token: Refresh token from the Enact API’s auth flow.
client_id: Client ID from the Enact API’s auth flow.
client_secret: Client secret from the Enact API’s auth flow.
subscription_key: Subscription key from the Enact API’s auth flow.
streams: List of data streams; this receiver ignores this field and fetches all data regardless of configuration, however for technical reasons the field must be present and be a list. An empty list is likely the best thing to put here, otherwise the schema below must be respected:
stream_type: Stream type – copied verbatim by receiver.
asset: Asset – copied verbatim by receiver.