How do I set up a web services test account?

  • Updated

Prior to December 2024, creation of API user accounts in the Test Environment was performed via a dedicated, Test-only API call (POST /account). This was due to the lack of a Test UI through which new account creation could be performed, and through which Test API access could be requested/granted.

With the Beta release of web services version 24.0 in December 2024, the initial creation of test API user accounts will now take place via the Portfolio Manager Test UI. This process will use the same “Create a New Account” workflow that is available in the Live/Production UI.

Any accounts that were created via the Test API prior to the launch of the Test UI will still be available; however, you will need the login credentials that you originally defined when you set up your Test account(s). If you no longer have access to this information, the best approach would be to create a new account via the Test UI.

New Test accounts that will be used to represent the API user/web service provider account will need to take the further step of enabling account-level API access. To do this:

  1. Log in to your Test “API user” account (via the Portfolio Manager Test UI) and click on “Account Settings” at the top of the page.
  2. From the subsequent “Edit Account” page, select the “Software Development” tab.
  3. On the “Software Development” tab, select “Yes” for the question “Will this account be used to test web services in the Test environment?” Additional text will appear below.
  4. At the bottom of the screen, click the button labeled “Start Using the Test Environment.”
  5. You will then be taken to another page, where you will be asked to make certain selections about your Web Services settings. At this stage, it is recommended that you indicate that you will be supporting data exchange for all energy meter types – but please note that any selections you make here can be easily updated in the future via your “Account Settings” in the Test UI.
  6. Click “Submit” and your Test account will be immediately registered and approved for API access.
  7. Begin working with the Test API and use the Test UI to validate the impact of these calls on the corresponding record(s).

Test accounts used solely to represent “test customer” accounts do not need to take further action before property records can be created within these accounts.

Was this article helpful?