Getting Started With API Integrations in Scaler – Scaler

What Is an API?

An API (application programming interface) is a software intermediary that allows two platforms to exchange information automatically. In Scaler, this typically means connecting your energy data provider or property management system so that data can be fetched and populated automatically into your Scaler environment.

API integrations remove manual data entry, reduce errors, and ensure that Scaler stays aligned with your source systems.

The API Integration Process

1️⃣ Preparation

Goal: Confirm technical feasibility and gather requirements.

Scaler reviews the provider’s API documentation, requests access to test or production environments, and aligns with the client on integration scope and expectations.

Timeframe: ~1–4 weeks

Varies based on provider responsiveness and documentation quality.

2️⃣ Development

Goal: Build and test the connection.

Scaler engineers develop the integration and test it in a secure staging environment before enabling it in production.

Timeframe: ~2 weeks from project start

3️⃣ Mapping

Goal: Match fields between the source platform and Scaler.

Clients map entities—such as assets and meters—to Scaler fields in Scaler or in bulk via spreadsheet.

Example: matching a meter ID from the provider’s platform to its corresponding meter in Scaler.

Timeframe: ~1–4 weeks

Depends on number of fields and client turnaround time.

📄 See our guide for proper API setup.

4️⃣ Synchronisation

Goal: Verify that data is flowing correctly.

Scaler fetches data from the provider and syncs it to the mapped fields.

Clients validate that the values in Scaler match the source system.

Timeframe: < 1 day

Checklists for a Successful API Integration

The following checklists outline what each party must provide to ensure a smooth integration.

Client Checklist

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 (e.g. 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: region(s), number of assets, and type of data (e.g. energy consumption)

Confirm the start date for data pulls (e.g. 1 January 2023)

Confirm the frequency of data pulls (e.g. monthly, quarterly)

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:

Prepare the mapping spreadsheet linking:

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

Third Party Provider Checklist

Authentication

Specify the authentication method(s) supported:

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 (e.g., 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 (e.g., asset ID or address)

Meter Information

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

Units

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

Consumption Data

Records include:

Data Granularity

Define available granularity (daily / monthly / 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 info on:

Documentation & Support

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

Provide a technical contact or support channel for integration questions

Third-Party Provider (outgoing platform)

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: