What information is needed to apply for LIVE Access to Web Services?

In early 2023 we'll be giving the Registration page for Web Services Live Access a facelift, and adding some new questions to streamline the review process. The following data will be required to apply for LIVE Access to Web Services: 

Section 1: Registration Questions
  1. Does your organization already have a Portfolio Manager account that has been approved for access to the web services API? [choose a single response]
    • Yes
      • Please provide account username, if known (enter “unknown” if necessary):
    • No
    • I don’t know
  2. Are you applying for API access as part of the instructions provided by another software platform that will be handling the web service calls (e.g., NISC, SkySpark, BEAM)? [choose a single response]
    • Yes
      • Please specify [free entry]
    • No
  3. Have you used the Portfolio Manager web services TEST API environment prior to requesting LIVE access? [choose a single response]
    • Yes
    • No
  4. Will you be using the API to integrate Portfolio Manager functionality into a customer- or public-facing software platform? [choose a single response]
    • Yes
      • Please indicate the name of the platform, as well as a link to any existing promotion/documentation for the platform [free entry]
    • No
  5. How will you be initiating data exchange with customers’ Portfolio Manager accounts and properties via the API? [choose a single response]
    • Our integration will be used to create the customers’ Portfolio Manager accounts and/or properties
    • Our integration will sync up with existing Portfolio Manager accounts and/or properties via the Connection/Sharing functionality
    • We will be using both of the pathways indicated above.
  6. What data do you anticipate exchanging with Portfolio Manager via API? [choose a single response]
    • We plan to just push property and/or consumption data to Portfolio Manager.
    • We plan to just pull back metrics from Portfolio Manager.
    • We intend to both push data to and pull data from Portfolio Manager.
  7. Following the initial “sync” between your system and the customer’s Portfolio Manager account, how do you envision that they will continue to use the Portfolio Manager interface? [Multi-select option]
    • Not at all – our platform will allow them to do everything they need to do.
    • They will continue to make any updates to the property record (e.g., property uses, property use details) via Portfolio Manager.
    • They will continue to make any updates to the meter consumption data via Portfolio Manager.
    • They will only use Portfolio Manager for the functions that cannot currently be performed via API (e.g., applying for ENERGY STAR certification).
  8. Do you have any outstanding technical questions regarding the Portfolio Manager web services API that you would like to discuss prior to being granted access to the LIVE API? [choose a single response]
    • Yes
      • Please describe [free entry]
    • No
Section 2 - Web Services Settings

9. What types of energy meters can your customers share with you?
 Electric
 Natural Gas
 Propane
 Fuel Oil (No. 2)
 Diesel
 District Steam
 District Hot Water
 District Chilled Water
See More Energy Sources

10. What types of water meters can your customers share with you?
 Municipally Supplied Potable Water
 Municipally Supplied Reclaimed Water
 Well Water
 Other

11. What types of Waste and Materials meters can your customers share with you?
 Disposed Waste and Materials
 Recycled Waste and Materials
 Donated/Reused Waste and Materials
 Composted Waste and Materials

12. What types of IT Energy meters can your customers share with you?
 Uninterruptible Power Supply (UPS) Output Meter
 Power Distribution Unit (PDU) Input Meter
 Power Distribution Unit (PDU) Output Meter
 IT Equipment Input Meter (on single piece of equipment)

13. What types of Plant Flow meters can your customers share with you?
 Average Influent Flow
 

14. Terms of Use for Your Customers:

 No Terms of Use required
 Enter Terms of Use to be displayed to customers in Portfolio Manager
 Provide a link that customers will use to access Terms of Use

Section 3: ENERGY STAR Web Services Terms of Use

15. Please review and approve the ENERGY STAR Web Services Terms of Use. 

Was this article helpful?