快速入门 - FranklinWH API Portal

Step 1: 获取 API Key 约 1 分钟

登录后，系统会自动为你生成沙盒环境的 API Key。

你的沙盒 API Key

fwh_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx

⚠️ 请妥善保管你的 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 调用

复制以下代码，获取你的站点列表：

cURL

curl -X GET "https://api.franklinwh.com/v2/sites" \
  -H "Authorization: Bearer fwh_sk_test_xxxx" \
  -H "Content-Type: application/json"

Python (requests)

import requests

# API 配置
BASE_URL = "https://api.franklinwh.com/v2"
API_KEY = "fwh_sk_test_xxxx"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

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

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

JavaScript (fetch)

const BASE_URL = 'https://api.franklinwh.com/v2';
const API_KEY = 'fwh_sk_test_xxxx';

// 获取站点列表
const response = await fetch(`${BASE_URL}/sites`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  }
});

const sites = await response.json();

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

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

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://api.franklinwh.com/v2/telemetry/realtime?device_ids=dev_001" \
  -H "Authorization: Bearer fwh_sk_test_xxxx"

查询历史数据：

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

← 上一步重新开始

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

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

🚀 5 分钟快速入门