快速入门 - FranklinWH API Portal

Step 1: 了解 API 环境约 1 分钟

FranklinWH API 提供两个环境，方便你开发和测试：

环境	Base URL	认证方式	数据类型
🧪 沙盒环境	`https://sandbox.api.franklinwh.com/v2`	无需认证	模拟数据
🚀 生产环境	`https://api.franklinwh.com/v2`	API Key	真实数据

💡 沙盒环境：无需注册、无需 API Key，直接调用即可获得模拟数据，适合快速评估和调试。

⚠️ 生产环境：需要通过 FleetView SSO 登录并开通套餐后获取 API Key。请妥善保管，不要在客户端代码或公开仓库中暴露。

下一步：选择语言 →

Step 2: 选择你的开发语言

cURL

Python

JavaScript

Go

Java

💡 FranklinWH 提供标准 REST API，你可以使用任何支持 HTTP 请求的语言或工具进行调用。

API 基础信息：

Base URL	`https://api.franklinwh.com/v2`
API Base URL	`https://api.franklinwh.com/v2`
认证方式	Header: `Authorization: Bearer {API_KEY}`
Content-Type	`application/json`

← 上一步下一步：发起调用 →

Step 3: 发起你的第一次 API 调用

使用沙盒环境，无需 API Key，直接复制以下代码获取模拟站点列表：

cURL

# 沙盒环境 - 无需认证
curl -X GET "https://sandbox.api.franklinwh.com/v2/sites" \
  -H "Content-Type: application/json"

Python (requests)

import requests

# 沙盒环境 - 无需认证
SANDBOX_URL = "https://sandbox.api.franklinwh.com/v2"

headers = {
    "Content-Type": "application/json"
}

# 获取站点列表
response = requests.get(f"{SANDBOX_URL}/sites", headers=headers)
sites = response.json()

# 打印结果
for site in sites["data"]:
    print(f"站点: {site['name']}, 状态: {site['status']}")

JavaScript (fetch)

// 沙盒环境 - 无需认证
const SANDBOX_URL = 'https://sandbox.api.franklinwh.com/v2';

const response = await fetch(`${SANDBOX_URL}/sites`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});

const sites = await response.json();

// 打印结果
sites.data.forEach(site => {
  console.log(`站点: ${site.name}, 状态: ${site.status}`);
});

💡 生产环境调用：如需访问真实数据，请先通过 FleetView SSO 登录并开通套餐获取 API Key，然后在请求头中添加 Authorization: Bearer {API_KEY}

← 上一步下一步：查看结果 →

Step 4: 查看响应结果成功

API 返回 JSON 格式的响应：

{
  "success": true,
  "data": [
    {
      "site_id": "site_001",
      "name": "Home Energy System",
      "status": "online",
      "device_count": 3,
      "total_capacity_kwh": 26.4
    },
    {
      "site_id": "site_002",
      "name": "Office Building",
      "status": "online",
      "device_count": 5,
      "total_capacity_kwh": 52.8
    }
  ],
  "pagination": {
    "total": 2,
    "page": 1,
    "per_page": 20
  }
}

📝 更多 API 调用示例（沙盒环境）：

获取设备实时遥测数据：

curl -X GET "https://sandbox.api.franklinwh.com/v2/telemetry/realtime?device_ids=dev_001"

查询历史数据：

curl -X GET "https://sandbox.api.franklinwh.com/v2/telemetry/history?device_id=dev_001&start=2026-03-01&end=2026-03-07"

← 上一步重新开始

🎉 恭喜！你已完成第一次 API 调用

接下来，你可以探索更多功能：

🚀 5 分钟快速入门