発電量実績の追加

ベースURL: https://api.tensorenergy.jp/v1

パス: /actuals/{ASSET_ID}

メソッド: POST

クエリパラメータ

このAPIはクエリパラメータを必要としません。

ボディ

リクエストボディには以下のフィールドを提供する必要があります:

フィールド	タイプ	説明
source	meter_confirmed | meter_preliminary | meter_preliminary_high_voltage | meter_preliminary_low_voltage | monitoring_generic | monitoring_laplace	プロジェクト実績データのソース
unit	kw | kwh	プロジェクト実績データの単位
data	[AssetActualSet]	プロジェクト実績データ

レスポンス

レスポンスは次のフィールドを持つnull不可のJSONオブジェクトです:

フィールド	タイプ	説明
success	boolean	変更が成功したかどうかを示すフラグ。
data	[AssetActualSet] | null	追加されたプロジェクト実績。successがfalseの場合、この値はnullになります。
error	Error | null	クエリから返されたエラー。successがtrueの場合、この値はnullになります。

AssetActualSetオブジェクト

フィールド	タイプ	説明
datetime	string	実績のタイムスタンプ。ISO 8601準拠のUTCタイムスタンプで表現されます。これは30分間隔であることが期待されます。例: 2021-01-01T00:30:00Z または 2021-01-01T01:00:00
value	float	エネルギー生成量。キロワット時（kWh）で表現されます。

エラーオブジェクト

フィールド	タイプ	説明
message	string	問題が発生したことを説明するメッセージ。
code	internal_server_error | not_authorized | invalid_payload | resource_not_found	発生したエラーコード。

リクエスト例

cURL

curl --request POST \
     --url https://api.tensorenergy.jp/v1/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3 \
     --header 'authorization: Bearer ${API_TOKEN}'
     --header 'Content-Type: application/json'
     --data '{"source": "meter_confirmed", "unit": "kwh", "data":[{"datetime": "2022-01-01T00:00:00Z, "value": 9.12}, {"datetime": "2022-01-01T00:30:00Z, "value": 15.12},{"datetime": "2022-01-01T01:00:00Z, "value": 19.123}]}'

Python

import requests

API_URL = 'https://api.tensorenergy.jp/v1/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3'
API_TOKEN = 'YOUR_API_KEY'

headers = {
    'authorization': f'Bearer {API_TOKEN}',
}

body = {
    'source': 'meter_confirmed',
    'unit': 'kwh',
    'data': [
        {
            'datetime': '2022-01-01T00:00:00Z',
            'value': 9.12
        },
        {
            'datetime': '2022-01-01T00:30:00Z',
            'value': 15.12
        },
        {
            'datetime': '2022-01-01T01:00:00Z',
            'value': 19.123
        },
    ]
}

response = requests.post(API_URL, headers=headers, json=body)

print(response.json())

Typescript

const API_URL = 'https://api.tensorenergy.jp/v1/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3'
const API_TOKEN = 'YOUR_API_KEY'
const payload = {
    source: 'meter_confirmed',
    unit: 'kwh',
    data: [
        {
            datetime: '2022-01-01T00:00:00Z',
            value: 9.12
        },
        {
            datetime: '2022-01-01T00:30:00Z',
            value: 15.12
        },
        {
            datetime: '2022-01-01T01:00:00Z',
            value: 19.123
        },
    ]
}

const fetchData = async () => {
    try {
        const response = await fetch(API_URL, {
          method: 'POST',
          headers: {
            'authorization': `Bearer ${API_TOKEN}`
          },
          body: JSON.stringify(payload)
        })
        console.log(response)
    } catch (error) {
        console.error(error)
    }
};

fetchData()

レスポンス例

プロジェクト実績が追加された場合

{
  "success": true,
  "data": [
        {
            "datetime": "2022-01-01T00:00:00Z",
            "value": 9.12
        },
        {
            "datetime": "2022-01-01T00:30:00Z",
            "value": 15.12
        },
        {
            "datetime": "2022-01-01T01:00:00Z",
            "value": 19.123
        },
    ],
    "error": null
}

操作中にエラーが発生した場合

{
  "success": false,
  "data": null,
  "error": {
    "message": "something went wrong during the process",
    "code": "internal_server_error"
  }
}