API Keys

1. Go to API Key and click Create.

2. Enter a Name and a Description for the API Key.

3. The API Key is generated and populated in the API Key field. Copy the key to a file.

4. The Secret Key is generated and populated in the Secret Keyfield. Copy the key to a file.

   Note:

   Secret Key is visible to the users only when you are creating the API keys. Once you have saved the API key and secret key pair, the key value is not visible.

5. Click Submit to complete.

You can use the created API Key as credentials to access the Webservice and Websocket.

Webservice

Send the API Key as a header via the Basic Authentication protocol with Base64 encryption. Encrypt the API Key.

Authorization:Basic (Base64 encryption) (apikey:secretkey)

Example:

Authorization: Basic MTIzNDUtMTIxMjEyLTEyMTIxMi0xMjEyOjEyMzQ1LTEyMTIxLTIxMjEyLTEyMTItMTIy

When the client is successfully connected, the client receives the responses.

Websocket Connectivity

Access the Websocket with authentication:

wss://<user>:base64(apikey:secretkey)@<Websocket URL>:PortNumber/AEDataTransmitter?name=<user>

Example:

wss://Agent1:MTIzNDUtMTIxMjEyLTEyMTIxMi0xMjEyOjEyMzQ1LTEyMTIxLTIxMjEyLTEyMTItMTIy@dev.aecdevops.com:4747/AEDataTransmitter?name=Agent1

where:
ApiKey – Generated API Key
SecretKey – Generated secret key. 
Encode the API Key - SecretKey pair using a Base64 encode utility and use the encoded result in the request.
Websocket URL – This is the Websocket URL and the Port, varies for each user.
User – The name of the client requesting access to the Websocket server.

When the client is successfully connected, the client receives the responses.