RESTful API
The documentation defined here is intended for developers to interface with Utility Cloud via the RESTful HTTPS API.
The API is documented in the Postman Platform located here: https://documenter.getpostman.com/view/10329688/SzKSUL4K. This platform allows developers to interact, discover, and work with resources and endpoints available in the API.
Prior to using the API, you must log in to Utility Cloud using one of the User Interface Addresses in the table below, to verify your username and create a password.
After you have logged into the system and verified your username, you must first request an Authentication Token that is passed with every subsequent request.
API-enabled environments
| Environment | User Interface Address | API Endpoint |
|---|---|---|
| Acceptance* | https://acc.ucld.us | https://api.ucld.us/env/acc |
| Production | https://ucld.us | https://api.ucld.us/env/prd |
| Environment | User Interface Address | API Endpoint |
|---|---|---|
| Acceptance* | https://acc.ucld.us | https://api.ucld.us/env/acc |
| Demo** | https://demo.ucld.us | https://api.ucld.us/env/demo |
| Production | https://ucld.us | https://api.ucld.us/env/prd |
* The acceptance environment is for testing, and access is limited. Please contact Utility Cloud support for access.
**Similarly, our demo environment is intended for testing, but it is open to anyone wishing to use it and contains recent copies of your data. For more information, see Demo environment.
C# Example
JavaScript Example
