API integration requirements – Scaler

Purpose of this article

This article outlines the requirements both your organization and your third-party data provider must meet to successfully integrate an API with Scaler. Use this checklist during the planning phase to ensure all stakeholders are prepared before implementation begins.

Integration process overview

Setting up an API integration involves four key phases:

Preparation — Confirm API readiness and align on technical requirements (3-4 weeks)

Development — Build and test the API connection in a staging environment (approximately 2 weeks from project start)

Mapping — Align fields between the external platform and Scaler (1-4 weeks)

Synchronization — Validate data flow between systems (under 1 day)

Timelines depend on provider responsiveness, documentation quality, number of fields, and client input speed.

Client requirements

Expand

Cost & agreement

Confirm cost indication for building and maintaining the API integration

Approve any additional fees charged by the third-party provider for API calls

Decide preferred data call frequency (monthly, quarterly) if costs apply

Integration ownership

Assign a client "owner" responsible for overseeing the API integration

Ensure this person can coordinate with Scaler and the third-party provider

Access & permissions

Provide Scaler login credentials or permissions to connect via API

Share test or production environment access for verification

Confirm Scaler can access the client account in the outgoing platform

Data scope & parameters

Define the scope of data to be synced:

Region(s)

Number of assets

Type of data (energy consumption, water, etc.)

Confirm the start date for data pulls (e.g., 2023-01-01)

Clarify which data source should be "leading" if overlap exists

Confirm the frequency of data pulls (monthly, quarterly)

Note that each pull reflects the previous full period (e.g., data pulled on 2023-03-05 covers 2023-01-01 to 2023-02-28)

Define the granularity of data (daily, monthly, quarterly, annual)

Provider outlook

Indicate whether you plan to continue using the current provider long-term

Note any likelihood of switching providers in the near future

Mapping work

Ensure all relevant entries in Scaler are created and aligned:

Assets

Meters

Other data fields (if applicable)

Prepare the mapping spreadsheet linking:

Include any additional field details (energy subcategory, source, area type)

Third-party provider requirements

Expand

Authentication

Specify the authentication method(s) supported:

Token-based

Username/password

OAuth or other

Confirm how credentials or tokens are issued and renewed

Environment access

Confirm access to test, staging, and production environments

Note any restrictions or unique configurations between environments

Rate limiting & quotas

Provide API rate limits (max calls per minute/hour/day)

Indicate whether Scaler can adjust polling frequency within limits

API protocol

Identify API type (REST, GraphQL, SOAP, other)

Share any specific protocol standards or requirements

Data access capabilities

Asset information

Each asset has a unique identifier (asset ID or address)

Meter information

Each meter has a unique ID and clear link to its asset

Units

Units of measurement are provided (kWh, m³, etc.)

Consumption data

Records include:

Start and end date/time

Consumption value

Unit or consumption type (water, electricity, etc.)

Data granularity

Define available granularity (daily, monthly, quarterly, annual)

Specify if multiple options exist

Bidirectional / redelivery data

Confirm if the API includes energy export/redelivery data

Describe structure and any known edge cases

End-to-end data flow

Outline the full data flow from assets → meters → units → consumption data

Ensure all endpoints and relationships are clearly defined

Integration details

Provide information on:

API versioning

Error handling and response codes

Synchronization or refresh logic

Documentation & support

Share available documentation (API reference, Postman collection, examples)

Provide a technical contact or support channel for integration questions

Third-party provider requirements (outgoing platform)

Expand

Contact details

Provide primary contact name

Provide email address for technical coordination

API scope & documentation

Confirm API documentation is available and up to date

Include an end-to-end flow describing which API calls to make (assets → meters → consumption)

Provide access to:

Indicate if the API can be shared via Postman API Platform for simplified testing

Note any API limitations, such as:

Authorization

Provide API keys, tokens, or credentials (where applicable)

Confirm authentication method (token, OAuth, etc.)

Initial data export

Share an export of relevant data IDs to support the initial mapping process:

Asset IDs

Meter IDs

Troubleshooting & common mistakes

Missing provider documentation → Contact the provider early to confirm API documentation exists and is accessible

Unclear data flow → Request a diagram or written description of how data moves from assets to meters to consumption records

Rate limits not disclosed → Ask the provider explicitly about API call limits to avoid integration delays

Mismatched meter IDs → Always fetch the latest data from Scaler before uploading mapping files to ensure IDs are current and valid

Additional resources

Setting up your API Integration

Switching third-party API providers

ENERGY STAR Portfolio Manager integration