How-to Integrate Your Third-Party API in Scaler
Integrating data from a third-party platform into Scaler is a crucial step in achieving accurate, automated data flows. Before activating the API connection, it’s important to properly set up your meters and, optionally, import historical data to ensure a seamless transition.
Follow the steps below to prepare your environment.
Summary Action Items
Action | Goal | |
1 | Export all meters from the third-party system | Gather all identifiers and meter details |
2 | Add meters in Scaler with matching details | Set up a consistent structure for mapping |
3 | Upload available historical data (optional) | Validate setup and gain early insights |
4 | Map meters in Scaler or via Bulk | Connect Scaler meters to your third party meters |
5 | Final check | Make sure that all the data is included |
Step 1: Get an Export from the Third Party
Start by requesting or generating a complete export of your meters from the third-party system. This export typically includes:
- Unique Meter IDs and corresponding meter descriptions
- Resource types (e.g., electricity, gas, water, etc.)
- Source (Grey, Green, etc.)
- Location or area associations
- Meter Start Date
Tips:
- Double-check that all meters relevant to your integration are included.
- If available, export data in a structured format such as CSV or Excel for easier import into Scaler.
- Keep a backup of this export — it’ll serve as your reference point for validation later.
Step 2: Add Meters in Scaler
See this article for more information on adding meters.
Create the meters in Scaler using the details from your export. Be sure to include:
- Meter name and type
- Associated asset or site
- Meter Start date, consumption will be included in the reports and analytics output from this date on.
- Optional: Any tags or grouping that match your existing structure
Pro Tip: Use the same Meter IDs as the ones from the third-party system. This makes it much easier to map and match data automatically once the API integration is live.
Checklist:
- Each meter is added and correctly linked to an asset
- Meter type and area type match the third-party export
For additional information, please check this page on our Scaler Knowledge Base about how to set up your meters in Scaler.
Step 3: Upload Historical Data (optional)
Before activating the live API connection, upload any historical data currently available from your third-party export. This helps you:
- Validate that your meters are set up correctly
- Gain insights into past performance before live data starts flowing
- Ensure your dashboards and reports already display meaningful trends
You can upload the data via a bulk import tool in Scaler.
Note: Once the API integration is live, the API will automatically override historical data where newer values are available. However, having this early import gives you a solid starting point and helps confirm that the mapping and configuration are correct.
For additional information, please check this page on our Scaler Knowledge Base about how to add consumption in Scaler.
Step 4: Map meters in Scaler or via Bulk
Depending on the amount of meters you need to map, you can choose to map the meters directly in Scaler or via a bulk upload template. There are two ways to map meters in Scaler, depending on how many meters you need to link:
Option 1: Manual Mapping
Use this method if you only need to map a few meters.
- Map assets first – Before linking any meters, make sure each External Asset ID is mapped to the corresponding Scaler Asset ID.
- Once the assets are mapped, you can link the meters one by one.
- Map each External Meter ID to the Meter ID you created in Scaler. Always fetch the latest information from Scaler to ensure accurate mapping.
- Be aware: If an ID doesn’t exist in Scaler, the mapping will fail.
Option 2: Bulk Mapping
Use this method if you want to map multiple meters at the same time.
- Prepare your data file containing both External Asset IDs and External Meter IDs.
- In the bulk mapping process, you can map assets and meters simultaneously.
- Map each External Asset ID to its Scaler Asset ID, and each External Meter ID to the Scaler Meter ID. Always fetch the latest data from Scaler before uploading to ensure all IDs exist and are correctly referenced.
Important Tip Always fetch data from Scaler before mapping. This ensures that all IDs are valid and prevents mapping errors.
Step 5: Final Check
- Confirm all meters appear correctly in Scaler;
- Verify that uploaded historical data matches what’s in the third-party system;
- Document the Meter ID mapping for easy troubleshooting later.