The Exergy API enables you to interact with Exergy using REST services
Confirm with your system administrator the APIKey you should be using. This will correspond with your Exergy config file, and can be used to switch between development, testing and production environments
Confirm the Username and password you should be using for each environment
For scenarios where you have longer lived sessions (a user signs on, and performs several tasks, and a session typically lasts for an hour or more), authenticate by generating a User Token
For integration scenarios where a service signs on to perform tasks, use the Authentication via Service Token method
Exergy uses GUIDs as primary keys, and to fetch objects, parameters will mostly be GUIDs. We sometimes refer to that as GIDs
This API mimics the Exergy .NET object model
A training course for Exergy programming which focusses on the .NET object model, is available
Use the provided Username and APIKey to obtain a token
The token expires after 60 minutes, after which you need to do a token refresh. The token result contains the expiry time, which you can use to check when you refresh the token
Do not hardcode the 60 minutes in your application, as this will change in future. Rather rely on the expiry time in the token result
The Authorization token should be included in your request header
Use the provided Username and APIKey to obtain a token
Then register this token as an service token for this user, by sending that to the Users/APIKey endpoint
Service Tokens never expire - you can revoke them using the users{id}/apiKey endpoint
The token should be included in your request header, prefaced with apiKey
apiKey thisismytoken