Using the Write API (version 24)

Canary offers a web API (over https) as well as a native gRPC API (over https) for 3rd parties wishing to write data to the Historian. API requests are routed through the Store and Forward (SaF) service through ports 55293 and 55391 respectively.

Authentication

API's make use of tokens for authentication which are configured within the Identity service.

Each token is linked to a Canary user. If Tag Security is enabled in the Identity service, the Canary user must be given write permissions to the appropriate DataSet(s) or local Historian view.

When using the web API, the user will specify the token in their request using the apiToken parameter.

Similarly, if the SaF service used to write data is remote from the Historian, it too must be configured to use an API token. (See How to Configure a Collector When Tag Security is Enabled.) This can be the same token that is used within the API request. See How to Create an API Token for more details.