The FranklinWH API is a unified developer access platform designed for authorized partners to connect with the FranklinWH System through secure and seamless API integration. It allows third-party software to access FranklinWH device data, monitor system performance, receive operational alerts, and achieve approved remote device control.
Features Built to Make Development Easy
10-Minute Quick Onboarding
With a step-by-step quick-start wizard and ready-to-use code examples, the FranklinWH API makes the first API call simple. Developers can quickly set up authentication, send a request, review the response, and finish integration within minutes.
FleetView SSO Access
The FranklinWH API streamlines partner onboarding with FleetView Single Sign-on (SSO). Installers can sign in using their existing FleetView account, with the API Portal automatically applying the associated device scope, eliminating duplicate account setup and repeated device binding.
Free Testing Environment
The FranklinWH API provides a safe, free testing environment where developers can validate each integration before moving to production. The test environment keeps consistent data formats, while allowing partners to test API requests, responses, and workflows without affecting real live data and devices.
Browser-Based API Testing
Developers can test the FranklinWH API by opening the API portal directly in a web browser, without first needing to set up tools or a local coding environment. The portal also generates code examples from the tested API calls, so developers can save them and adapt them later when building the real integration.
Enterprise-Level Security
The API is designed with security in mind. Communications are protected with TLS 1.3 encryption, and API keys are stored as hashes rather than plaintext. Built-in rate limiting and anomaly detection help prevent excessive requests, misuse, and suspicious access. API responses also exclude personally identifiable information (PII), helping partners protect user privacy and follow data protection rules.
Complete Energy Flow Data
The API provides complete energy flow data to meet diverse integration needs. Developers can access a clear breakdown of power flows, including solar to load/battery/grid, battery to load/grid, and grid to load. The detailed data model helps partners build accurate monitoring, analytics, billing, and energy management applications.
Flexible Permission Control
The API allows flexible permission control for different partner needs. In addition to the general API for standard integrations, FranklinWH can provide customized APIs for large customers, with access managed down to individual feature level. This fine-grained permission approach helps partners access the authorized functions and data specific to their integration.
Enabling Advanced Energy Management for Authorized Partners
Third-Party Owners (TPOs) or Financiers
Third-party owners and financiers can use FranklinWH API to build applications that monitor the performance of financed energy systems across their portfolios. By accessing device status, energy production, system operation, alerts, and historical data, they can track asset performance, evaluate return on investment, and enable more efficient portfolio management.
Large or Midsize Installers
With API, large and midsize installers can build custom applications that go beyond standard FleetView device tracking. By integrating device data into their own service platforms, they can enable advanced workflows such as error monitoring across multiple installer portfolios, internal reporting, and access to diagnostic records and system events for proactive troubleshooting. These capabilities help improve operational efficiency and reduce service costs.
Third-Party Service Providers
Third-party service providers can leverage the FranklinWH API to connect FranklinWH System data with specialized external platforms so they can offer value-added services such as building or property management, energy benchmarking, and carbon tracking and sustainability reporting, etc.