Back to top

エネがえる AIsense API

管理系

企業管理

エネがえるサービス利用ユーザーの企業情報 システム管理者(authority_level=1) または 企業管理者(authority_level=2) のみ実行可能

企業リスト取得
GET/corporations/

企業情報（複数）を取得します。（企業管理者の場合は自身の企業情報のみ）
システム管理者の場合のレスポンスは下記のとおり、企業管理者の場合は個別企業情報の企業情報取得と同じレスポンスとなります。

Example URI

GET https://api.enegaeru.com/aisense/corporations/
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "corp_id": "C1234567890",
    "name": "国際航業株式会社",
    "last_name": "国際",
    "first_name": "太郎",
    "post": "企画部",
    "zip_cd": "1000005",
    "email": "email@example.com",
    "contract_from": "2019-12-31T15:00:00.000Z",
    "contract_to": "2020-12-30T15:00:00.000Z",
    "modified": "2019-01-24T06:17:49.811Z"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "corp_id": {
        "type": "string",
        "description": "企業ID"
      },
      "name": {
        "type": "string",
        "description": "企業名称"
      },
      "last_name": {
        "type": "string",
        "description": "契約責任者氏名（姓）"
      },
      "first_name": {
        "type": "string",
        "description": "契約責任者氏名（名）"
      },
      "post": {
        "type": "string",
        "description": "所属部署名"
      },
      "zip_cd": {
        "type": "string",
        "description": "郵便番号"
      },
      "email": {
        "type": "string",
        "description": "問い合わせ用メールアドレス"
      },
      "contract_from": {
        "type": "string",
        "description": "契約期間開始日（未定時 null）"
      },
      "contract_to": {
        "type": "string",
        "description": "契約期間終了日（未定時 null）"
      },
      "modified": {
        "type": "string",
        "description": "レコード更新日時"
      }
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

企業情報登録
POST/corporations/

新規企業を登録します。（システム管理者のみ）

  • bill_corp_name, bill_post, bill_zip_cd, bill_addres はすべて未指定あるいはすべて指定のいずれか。

Example URI

POST https://api.enegaeru.com/aisense/corporations/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "国際航業株式会社",
  "last_name": "国際",
  "first_name": "太郎",
  "post": "企画部",
  "zip_cd": "1000005",
  "email": "email@example.com",
  "contract_from": "2020-01-01",
  "contract_to": "2020-12-31"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "企業名称"
    },
    "last_name": {
      "type": "string",
      "description": "契約責任者氏名（姓）"
    },
    "first_name": {
      "type": "string",
      "description": "契約責任者氏名（名）"
    },
    "post": {
      "type": "string",
      "description": "所属部署名"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "問い合わせ用メールアドレス"
    },
    "contract_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間開始日（YYYY-MM-DD形式、未定時 null）"
    },
    "contract_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間終了日（YYYY-MM-DD形式、未定時 null）"
    }
  },
  "required": [
    "name"
  ]
}
Response  200
HideShow
Body
{
  "corp_id": "C1234567890",
  "created": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "corp_id": {
      "type": "string",
      "description": "企業ID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

個別企業管理

エネがえるサービス利用ユーザーの企業情報 システム管理者のみ実行可能（企業管理者は id を指定した操作はできません。）

企業情報取得
GET/corporations/{corp_id}

指定した企業の登録情報を取得します。

Example URI

GET https://api.enegaeru.com/aisense/corporations/C1234567890
URI Parameters
HideShow
corp_id
string (required) Example: C1234567890

企業ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "国際航業株式会社",
  "last_name": "国際",
  "first_name": "太郎",
  "post": "企画部",
  "zip_cd": "1000005",
  "email": "email@example.com",
  "contract_from": "2020-01-01",
  "contract_to": "2020-12-31"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "企業名称"
    },
    "last_name": {
      "type": "string",
      "description": "契約責任者氏名（姓）"
    },
    "first_name": {
      "type": "string",
      "description": "契約責任者氏名（名）"
    },
    "post": {
      "type": "string",
      "description": "所属部署名"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "問い合わせ用メールアドレス"
    },
    "contract_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間開始日（YYYY-MM-DD形式、未定時 null）"
    },
    "contract_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間終了日（YYYY-MM-DD形式、未定時 null）"
    }
  },
  "required": [
    "name"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

企業情報削除
DELETE/corporations/{corp_id}

指定した企業の登録情報を削除します。

Example URI

DELETE https://api.enegaeru.com/aisense/corporations/C1234567890
URI Parameters
HideShow
corp_id
string (required) Example: C1234567890

企業ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "corp_id": "C1234567890",
  "deleted": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "corp_id": {
      "type": "string",
      "description": "企業ID"
    },
    "deleted": {
      "type": "string",
      "description": "レコード削除日時"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

企業情報更新
PUT/corporations/{corp_id}

指定した企業の登録情報を更新します。

Example URI

PUT https://api.enegaeru.com/aisense/corporations/C1234567890
URI Parameters
HideShow
corp_id
string (required) Example: C1234567890

企業ID

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "国際航業株式会社",
  "last_name": "国際",
  "first_name": "太郎",
  "post": "企画部",
  "zip_cd": "1000005",
  "email": "email@example.com",
  "contract_from": "2020-01-01",
  "contract_to": "2020-12-31"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "企業名称"
    },
    "last_name": {
      "type": "string",
      "description": "契約責任者氏名（姓）"
    },
    "first_name": {
      "type": "string",
      "description": "契約責任者氏名（名）"
    },
    "post": {
      "type": "string",
      "description": "所属部署名"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "問い合わせ用メールアドレス"
    },
    "contract_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間開始日（YYYY-MM-DD形式、未定時 null）"
    },
    "contract_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "契約期間終了日（YYYY-MM-DD形式、未定時 null）"
    }
  },
  "required": [
    "name"
  ]
}
Response  200
HideShow
Body
{
  "corp_id": "C1234567890",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "corp_id": {
      "type": "string",
      "description": "企業ID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

ユーザー管理

ユーザーリスト取得
GET/users/

ユーザー情報（複数）を取得します。

Example URI

GET https://api.enegaeru.com/aisense/users/
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "user_id": "U1234567890",
    "name": "user0000@example.com",
    "full_name": "国際太郎",
    "authority_level": "2",
    "last_logined": "2018-12-31T15:00:00.000Z",
    "lock_count": 0,
    "lock_date": "null",
    "modified_id": "00000000",
    "modified": "2019-01-24T06:17:49.811Z",
    "created_id": "00000000000",
    "created": "2019-01-24T06:17:49.811Z",
    "corp_id": 0
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "user_id": {
        "type": "string",
        "description": "ユーザーID"
      },
      "name": {
        "type": "string",
        "description": "ユーザー名"
      },
      "full_name": {
        "type": "string",
        "description": "氏名"
      },
      "authority_level": {
        "type": "string",
        "description": "権限レベル（1:システム管理者(システム管理者のみ指定可), 2:企業管理者）"
      },
      "last_logined": {
        "type": "string",
        "description": "前回ログイン日時"
      },
      "lock_count": {
        "type": "number",
        "description": "ロックカウント（パスワードエラーごとにカウント）"
      },
      "lock_date": {
        "type": "string",
        "description": "ロックアウトした日時"
      },
      "modified_id": {
        "type": "string",
        "description": "レコード更新者ID"
      },
      "modified": {
        "type": "string",
        "description": "レコード更新日時"
      },
      "created_id": {
        "type": "string",
        "description": "レコード作成者ID"
      },
      "created": {
        "type": "string",
        "description": "レコード作成日時"
      },
      "corp_id": {
        "type": "number",
        "description": "企業ID"
      }
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

ユーザー情報登録
POST/users/

新規ユーザーを登録します。

Example URI

POST https://api.enegaeru.com/aisense/users/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "user0000@example.com",
  "password": "Password",
  "authority_level": 2,
  "full_name": "国際",
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "ユーザー名"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    },
    "authority_level": {
      "type": "number",
      "description": "権限レベル（1:システム管理者(システム管理者のみ指定可), 2:企業管理者）"
    },
    "full_name": {
      "type": "string",
      "description": "氏名"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID（API実行ユーザーが システム管理者の場合のみ指定可能。）"
    }
  },
  "required": [
    "name",
    "password",
    "authority_level",
    "full_name"
  ]
}
Response  200
HideShow
Body
{
  "user_id": "U1234567890",
  "created": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ユーザーID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

ユーザー情報更新
PUT/users/

営業担当者が自分自身のパスワードを変更するために使用します。

Example URI

PUT https://api.enegaeru.com/aisense/users/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "password": "Password"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "password": {
      "type": "string",
      "description": "新しいパスワード"
    }
  },
  "required": [
    "password"
  ]
}
Response  200
HideShow
Body
{
  "user_id": "U1234567890",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ユーザーID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

個別ユーザー管理

ユーザー情報取得
GET/users/{user_id}

指定したユーザーのユーザー情報を取得します。
システム管理者、企業管理者のみ実行可能です。

Example URI

GET https://api.enegaeru.com/aisense/users/U1234567890
URI Parameters
HideShow
user_id
string (required) Example: U1234567890

ユーザーID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_id": "U1234567890",
  "name": "user0000@example.com",
  "full_name": "国際",
  "authority_level": 2,
  "last_logined": "2018-12-31T15:00:00.000Z",
  "lock_count": 0,
  "lock_date": "null",
  "modified_id": "00000000",
  "modified": "2019-01-24T06:17:49.811Z",
  "created_id": "00000000000",
  "created": "2019-01-24T06:17:49.811Z",
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ユーザーID"
    },
    "name": {
      "type": "string",
      "description": "ユーザー名"
    },
    "full_name": {
      "type": "string",
      "description": "氏名"
    },
    "authority_level": {
      "type": "number",
      "description": "権限レベル（1:システム管理者(システム管理者のみ指定可), 2:企業管理者）"
    },
    "last_logined": {
      "type": "string",
      "description": "前回ログイン日時"
    },
    "lock_count": {
      "type": "number",
      "description": "ロックカウント（パスワードエラーごとにカウント）"
    },
    "lock_date": {
      "type": "string",
      "description": "ロックアウトした日時"
    },
    "modified_id": {
      "type": "string",
      "description": "レコード更新者ID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    },
    "created_id": {
      "type": "string",
      "description": "レコード作成者ID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

ユーザー情報削除
DELETE/users/{user_id}

指定したユーザーのユーザー情報を削除します。（ログインユーザー自身の削除はできません。）
システム管理者、企業管理者のみ実行可能です。

Example URI

DELETE https://api.enegaeru.com/aisense/users/U1234567890
URI Parameters
HideShow
user_id
string (required) Example: U1234567890

ユーザーID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_id": "U1234567890",
  "deleted": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ユーザーID"
    },
    "deleted": {
      "type": "string",
      "description": "レコード削除日時"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

ユーザー情報更新
PUT/users/{user_id}

指定したユーザーのユーザー情報を更新します。

Example URI

PUT https://api.enegaeru.com/aisense/users/U1234567890
URI Parameters
HideShow
user_id
string (required) Example: U1234567890

ユーザーID

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "user0000@example.com",
  "password": "Password",
  "full_name": "国際",
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "ユーザー名"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    },
    "full_name": {
      "type": "string",
      "description": "氏名"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID（API実行ユーザーが システム管理者の場合のみ指定可能。）"
    }
  }
}
Response  200
HideShow
Body
{
  "user_id": "U1234567890",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ユーザーID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

デバイス管理

デバイスリスト取得
GET/devices/

機器情報（複数）を取得します。

Example URI

GET https://api.enegaeru.com/aisense/devices/
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "dev_id": "D1234567890",
    "devices_no": "dev0000",
    "zip_cd": "1000005",
    "pv_info": {},
    "sell_price": 0,
    "panels": [
      {
        "installation": 2,
        "azimuth": 0,
        "tilt": 23,
        "vol": 4
      }
    ],
    "cell_info": {
      "rated_capacity": 10,
      "actual_capacity": 90
    },
    "epcorp_cd": 1,
    "epplan_cd": 1,
    "capacity": 10,
    "ampare": 10,
    "modified_id": "00000000",
    "modified": "2019-01-24T06:17:49.811Z",
    "created_id": "00000000000",
    "created": "2019-01-24T06:17:49.811Z",
    "corp_id": 0
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "dev_id": {
        "type": "string",
        "description": "デバイスID"
      },
      "devices_no": {
        "type": "string",
        "description": "デバイス番号"
      },
      "zip_cd": {
        "type": "string",
        "description": "郵便番号"
      },
      "pv_info": {
        "type": "object",
        "properties": {},
        "description": "蓄電池の情報"
      },
      "sell_price": {
        "type": "number",
        "description": "売電単価"
      },
      "panels": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "installation": {
              "type": "number",
              "description": "設置形態（1:架台設置, 2:屋根置き）"
            },
            "azimuth": {
              "type": "number",
              "description": "方位角 (-179～180度)"
            },
            "tilt": {
              "type": "number",
              "description": "傾斜角 (0～90度)"
            },
            "vol": {
              "type": "number",
              "description": "出力値 1方角あたりの出力(kWh)"
            }
          }
        },
        "description": "太陽光パネルの情報 (配列)"
      },
      "cell_info": {
        "type": "object",
        "properties": {
          "rated_capacity": {
            "type": "number",
            "description": "定格容量(kWh)"
          },
          "actual_capacity": {
            "type": "number",
            "description": "実効容量(%)"
          }
        },
        "description": "蓄電池の情報"
      },
      "epcorp_cd": {
        "type": "number",
        "description": "電気事業者コード"
      },
      "epplan_cd": {
        "type": "number",
        "description": "料金プランコード"
      },
      "capacity": {
        "type": "number",
        "description": "契約容量 (kW) ※アンペアか容量のどちらかの入力が必須"
      },
      "ampare": {
        "type": "number",
        "description": "契約アンペア (A)  ※アンペアか容量のどちらかの入力が必須"
      },
      "modified_id": {
        "type": "string",
        "description": "レコード更新者ID"
      },
      "modified": {
        "type": "string",
        "description": "レコード更新日時"
      },
      "created_id": {
        "type": "string",
        "description": "レコード作成者ID"
      },
      "created": {
        "type": "string",
        "description": "レコード作成日時"
      },
      "corp_id": {
        "type": "number",
        "description": "企業ID"
      }
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

デバイス情報登録
POST/devices/

新規デバイスを登録します。
システム管理者、企業管理者のみ実行可能です。

Example URI

POST https://api.enegaeru.com/aisense/devices/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "device_no": "dev0000",
  "password": "Password",
  "zip_cd": "1000005",
  "sell_price": 0,
  "panels": [
    {
      "installation": 2,
      "azimuth": 0,
      "tilt": 23,
      "vol": 4
    }
  ],
  "cell_info": {
    "rated_capacity": 10,
    "actual_capacity": 90
  },
  "epcorp_cd": 1,
  "epplan_cd": 1,
  "capacity": 10,
  "ampare": 10,
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "device_no": {
      "type": "string",
      "description": "デバイス固有番号"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "pv_info": {
      "type": "object",
      "properties": {},
      "description": "蓄電池の情報"
    },
    "sell_price": {
      "type": "number",
      "description": "売電単価"
    },
    "panels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "installation": {
            "type": "number",
            "description": "設置形態（1:架台設置, 2:屋根置き）"
          },
          "azimuth": {
            "type": "number",
            "description": "方位角 (-179～180度)"
          },
          "tilt": {
            "type": "number",
            "description": "傾斜角 (0～90度)"
          },
          "vol": {
            "type": "number",
            "description": "出力値 1方角あたりの出力(kWh)"
          }
        }
      },
      "description": "太陽光パネルの情報 (配列)"
    },
    "cell_info": {
      "type": "object",
      "properties": {
        "rated_capacity": {
          "type": "number",
          "description": "定格容量(kWh)"
        },
        "actual_capacity": {
          "type": "number",
          "description": "実効容量(%)"
        }
      },
      "required": [
        "rated_capacity",
        "actual_capacity"
      ],
      "description": "蓄電池の情報"
    },
    "epcorp_cd": {
      "type": "number",
      "description": "電気事業者コード"
    },
    "epplan_cd": {
      "type": "number",
      "description": "料金プランコード"
    },
    "capacity": {
      "type": "number",
      "description": "契約容量 (kW) ※アンペアか容量のどちらかの入力が必須"
    },
    "ampare": {
      "type": "number",
      "description": "契約アンペア (A)  ※アンペアか容量のどちらかの入力が必須"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID（API実行ユーザーが システム管理者の場合のみ指定可能。）"
    }
  },
  "required": [
    "device_no",
    "password",
    "sell_price",
    "epcorp_cd",
    "epplan_cd"
  ]
}
Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "created": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

個別デバイス管理

デバイス情報取得
GET/devices/{dev_id}

指定したデバイスのデバイス情報を取得します。
システム管理者、企業管理者のみ実行可能です。（営業担当者は idを指定した実行はできません。）

Example URI

GET https://api.enegaeru.com/aisense/devices/D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "dev_id": "D1234567890",
  "devices_no": "dev0000",
  "zip_cd": "1000005",
  "pv_info": {},
  "sell_price": 0,
  "panels": [
    {
      "installation": 2,
      "azimuth": 0,
      "tilt": 23,
      "vol": 4
    }
  ],
  "cell_info": {
    "rated_capacity": 10,
    "actual_capacity": 90
  },
  "epcorp_cd": 1,
  "epplan_cd": 1,
  "capacity": 10,
  "ampare": 10,
  "modified_id": "00000000",
  "modified": "2019-01-24T06:17:49.811Z",
  "created_id": "00000000000",
  "created": "2019-01-24T06:17:49.811Z",
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "devices_no": {
      "type": "string",
      "description": "デバイス番号"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "pv_info": {
      "type": "object",
      "properties": {},
      "description": "蓄電池の情報"
    },
    "sell_price": {
      "type": "number",
      "description": "売電単価"
    },
    "panels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "installation": {
            "type": "number",
            "description": "設置形態（1:架台設置, 2:屋根置き）"
          },
          "azimuth": {
            "type": "number",
            "description": "方位角 (-179～180度)"
          },
          "tilt": {
            "type": "number",
            "description": "傾斜角 (0～90度)"
          },
          "vol": {
            "type": "number",
            "description": "出力値 1方角あたりの出力(kWh)"
          }
        }
      },
      "description": "太陽光パネルの情報 (配列)"
    },
    "cell_info": {
      "type": "object",
      "properties": {
        "rated_capacity": {
          "type": "number",
          "description": "定格容量(kWh)"
        },
        "actual_capacity": {
          "type": "number",
          "description": "実効容量(%)"
        }
      },
      "description": "蓄電池の情報"
    },
    "epcorp_cd": {
      "type": "number",
      "description": "電気事業者コード"
    },
    "epplan_cd": {
      "type": "number",
      "description": "料金プランコード"
    },
    "capacity": {
      "type": "number",
      "description": "契約容量 (kW) ※アンペアか容量のどちらかの入力が必須"
    },
    "ampare": {
      "type": "number",
      "description": "契約アンペア (A)  ※アンペアか容量のどちらかの入力が必須"
    },
    "modified_id": {
      "type": "string",
      "description": "レコード更新者ID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    },
    "created_id": {
      "type": "string",
      "description": "レコード作成者ID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

デバイス情報削除
DELETE/devices/{dev_id}

指定したデバイスのデバイス情報を削除します。
システム管理者、企業管理者のみ実行可能です。

Example URI

DELETE https://api.enegaeru.com/aisense/devices/D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "dev_id": "D1234567890",
  "deleted": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "deleted": {
      "type": "string",
      "description": "レコード削除日時"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

デバイス情報更新
PUT/devices/{dev_id}

指定したデバイスのデバイス情報を更新します。
システム管理者、企業管理者のみ実行可能です。

Example URI

PUT https://api.enegaeru.com/aisense/devices/D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "device_no": "dev0000",
  "password": "Password",
  "zip_cd": "1000005",
  "panels": [
    {
      "installation": 2,
      "azimuth": 0,
      "tilt": 23,
      "vol": 4
    }
  ],
  "cell_info": {
    "rated_capacity": 10,
    "actual_capacity": 90
  },
  "epcorp_cd": 1,
  "epplan_cd": 1,
  "capacity": 10,
  "ampare": 10,
  "corp_id": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "device_no": {
      "type": "string",
      "description": "型番・デバイス番号"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    },
    "zip_cd": {
      "type": "string",
      "description": "郵便番号"
    },
    "pv_info": {
      "type": "object",
      "properties": {},
      "description": "蓄電池の情報"
    },
    "sell_price": {
      "type": "number",
      "description": "売電単価"
    },
    "panels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "installation": {
            "type": "number",
            "description": "設置形態（1:架台設置, 2:屋根置き）"
          },
          "azimuth": {
            "type": "number",
            "description": "方位角 (-179～180度)"
          },
          "tilt": {
            "type": "number",
            "description": "傾斜角 (0～90度)"
          },
          "vol": {
            "type": "number",
            "description": "出力値 1方角あたりの出力(kWh)"
          }
        }
      },
      "description": "太陽光パネルの情報 (配列)"
    },
    "cell_info": {
      "type": "object",
      "properties": {
        "rated_capacity": {
          "type": "number",
          "description": "定格容量(kWh)"
        },
        "actual_capacity": {
          "type": "number",
          "description": "実効容量(%)"
        }
      },
      "description": "蓄電池の情報"
    },
    "epcorp_cd": {
      "type": "number",
      "description": "電気事業者コード"
    },
    "epplan_cd": {
      "type": "number",
      "description": "料金プランコード"
    },
    "capacity": {
      "type": "number",
      "description": "契約容量 (kW) ※アンペアか容量のどちらかの入力が必須"
    },
    "ampare": {
      "type": "number",
      "description": "契約アンペア (A)  ※アンペアか容量のどちらかの入力が必須"
    },
    "corp_id": {
      "type": "number",
      "description": "企業ID（API実行ユーザーが システム管理者の場合のみ指定可能。）"
    }
  }
}
Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

制御系

実績データ

実績データ登録
POST/actuals/

指定したデバイスの太陽光・蓄電池・消費電力等の1時間の実績値を登録します。

Example URI

POST https://api.enegaeru.com/aisense/actuals/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "dev_id": "D1234567890",
  "actual_data": [
    {
      "date": "2022-01-01",
      "time": 1,
      "pv_power": 4.2,
      "load_power": 2.1,
      "purchase_power": 0,
      "sell_power": 2,
      "discharge_power": 0,
      "charge_power": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "actual_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "指定年月日 YYYY-MM-DD"
          },
          "time": {
            "type": "number",
            "description": "時間 0～23"
          },
          "pv_power": {
            "type": "number",
            "description": "発電電力量(kWh)"
          },
          "load_power": {
            "type": "number",
            "description": "負荷電力量(kWh)"
          },
          "purchase_power": {
            "type": "number",
            "description": "購入電力量(kWh)"
          },
          "sell_power": {
            "type": "number",
            "description": "売電電力量(kWh)"
          },
          "discharge_power": {
            "type": "number",
            "description": "蓄電池放電量(kWh)"
          },
          "charge_power": {
            "type": "number",
            "description": "蓄電池充電量(kWh)"
          }
        },
        "required": [
          "date",
          "time",
          "pv_power",
          "load_power",
          "purchase_power",
          "sell_power",
          "discharge_power",
          "charge_power"
        ]
      },
      "description": "実績データ 時間毎に設定"
    }
  },
  "required": [
    "dev_id",
    "actual_data"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "dev_id": "D1234567890",
  "recorded_data": [
    "date `2022-01-01`",
    [
      "time",
      1
    ]
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "recorded_data": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ]
        }
      ],
      "description": "登録完了データ"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

実績データ更新
PUT/actuals/{?dev_id}

指定したデバイスの太陽光・蓄電池・消費電力等の1時間の実績値を更新します。

Example URI

PUT https://api.enegaeru.com/aisense/actuals/?dev_id=D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "actual_data": [
    {
      "date": "2022-01-01",
      "time": 1,
      "pv_power": 4.2,
      "load_power": 2.1,
      "purchase_power": 0,
      "sell_power": 2,
      "discharge_power": 0,
      "charge_power": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "actual_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "指定年月日 YYYY-MM-DD"
          },
          "time": {
            "type": "number",
            "description": "時間 0～23"
          },
          "pv_power": {
            "type": "number",
            "description": "発電電力量(kWh)"
          },
          "load_power": {
            "type": "number",
            "description": "負荷電力量(kWh)"
          },
          "purchase_power": {
            "type": "number",
            "description": "購入電力量(kWh)"
          },
          "sell_power": {
            "type": "number",
            "description": "売電電力量(kWh)"
          },
          "discharge_power": {
            "type": "number",
            "description": "蓄電池放電量(kWh)"
          },
          "charge_power": {
            "type": "number",
            "description": "蓄電池充電量(kWh)"
          }
        },
        "required": [
          "date",
          "time",
          "pv_power",
          "load_power",
          "purchase_power",
          "sell_power",
          "discharge_power",
          "charge_power"
        ]
      },
      "description": "実績データ 時間毎に設定"
    }
  },
  "required": [
    "actual_data"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "dev_id": "Hello, world!",
  "recorded_data": [
    "date `2022-01-01`",
    [
      "time",
      1
    ]
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "recorded_data": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ]
        }
      ],
      "description": "更新完了データ"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

発電量予測

予測取得(太陽光)
GET/forecasts/pv/{?dev_id,date}

デバイスIDより太陽光の予測情報を取得します。
【TODO】更新時間とかの説明

Example URI

GET https://api.enegaeru.com/aisense/forecasts/pv/?dev_id=D1234567890&date=2022-01-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

date
string (required) Example: 2022-01-01

予測年月日 YYYY-MM-DD

Response  200
HideShow
Body
{
  "dev_id": "Hello, world!",
  "forecast_data": [
    {
      "date": "2022-01-01",
      "power": [
        0.564
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "forecast_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "予測年月日 YYYY-MM-DD"
          },
          "power": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "予測した発電量の配列(長さ48コマ(0:00～23:30))"
          }
        }
      },
      "description": "予測データ"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

需要量予測

予測取得(需要量)
GET/forecasts/demand/{?dev_id,date}

デバイスIDより需要量の予測情報を取得します。
(TODO)更新時間とかの説明。。。。

Example URI

GET https://api.enegaeru.com/aisense/forecasts/demand/?dev_id=D1234567890&date=2022-01-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

date
string (required) Example: 2022-01-01

予測年月日 YYYY-MM-DD

Response  200
HideShow
Body
{
  "dev_id": "Hello, world!",
  "forecast_data": [
    {
      "date": "2022-01-01",
      "power": [
        0.564
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "forecast_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "予測年月日 YYYY-MM-DD"
          },
          "power": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "予測した需要量の配列(長さ48コマ(0:00～23:30))"
          }
        }
      },
      "description": "予測データ"
    }
  },
  "required": [
    "dev_id"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

蓄電池制御

制御情報取得(蓄電池)
GET/controls_cell/{?dev_id,date}

デバイスIDと指定年月日より蓄電池充放電制御情報を取得します。
毎日0,12時に更新、36時間先まで予測

Example URI

GET https://api.enegaeru.com/aisense/controls_cell/?dev_id=D1234567890&date=2022-01-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

date
string (required) Example: 2022-01-01

指定年月日 YYYY-MM-DD

Response  200
HideShow
Body
{
  "dev_id": "Hello, world!",
  "controls": [
    {
      "date": "2022-01-01",
      "charge_power": [
        0.564
      ],
      "discharge_power": [
        0.564
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "controls": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "予測年月日 YYYY-MM-DD"
          },
          "charge_power": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "蓄電池充電情報の配列(長さ48コマ(0:00～23:30))"
          },
          "discharge_power": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "蓄電池放電情報の配列(長さ48コマ(0:00～23:30))"
          }
        }
      },
      "description": "予測データ"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

料金計算系

時間別 設備導入効果額

時間別 設備導入効果取得
GET/charges/hourly/{?dev_id,date}

デバイスID、日付により1時間別の設備の導入効果を取得します。
毎日0時更新

Example URI

GET https://api.enegaeru.com/aisense/charges/hourly/?dev_id=D1234567890&date=2022-01-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

date
string (required) Example: 2022-01-01

指定年月日 YYYY-MM-DD

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "benefit_data": [
    {
      "date": "2022-01-01",
      "time": 1,
      "sell_benefit": 4.2,
      "pv_benefit": 0,
      "battery_benefit": 2,
      "electrical_charges": 2.1
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "benefit_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "効果額年月日  YYYY-MM-DD"
          },
          "time": {
            "type": "number",
            "description": "時間 0～23"
          },
          "sell_benefit": {
            "type": "number",
            "description": "売電収入(円)"
          },
          "pv_benefit": {
            "type": "number",
            "description": "太陽光 自家消費効果額(円)"
          },
          "battery_benefit": {
            "type": "number",
            "description": "売電電力量(円)"
          },
          "electrical_charges": {
            "type": "number",
            "description": "電気料金(従量料金＋再エネ賦課金＋燃調費)（円）"
          }
        }
      },
      "description": "効果額データ"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

月別 設備導入効果額

月別 設備導入効果取得
GET/charges/monthly/{?dev_id,year_month}

デバイスID、日時情報により月別の設備の導入効果を取得します。

Example URI

GET https://api.enegaeru.com/aisense/charges/monthly/?dev_id=D1234567890&year_month=2022-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

year_month
string (required) Example: 2022-01

指定年月 YYYY-MM

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "date": "2022-01",
  "sell_benefit": 4.2,
  "pv_benefit": 0,
  "battery_benefit": 2,
  "electrical_charges": [
    {
      "base_charges": 1200,
      "volume_charges": 3000,
      "fuel": -450,
      "renewable_surcharges": 1000,
      "total": 3750
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "date": {
      "type": "string",
      "description": "効果額年月日  YYYY-MM"
    },
    "sell_benefit": {
      "type": "number",
      "description": "売電収入(円)"
    },
    "pv_benefit": {
      "type": "number",
      "description": "太陽光 自家消費効果額(円)"
    },
    "battery_benefit": {
      "type": "number",
      "description": "売電電力量(円)"
    },
    "electrical_charges": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "base_charges": {
            "type": "number",
            "description": "基本料金（円）"
          },
          "volume_charges": {
            "type": "number",
            "description": "従量料金（円）"
          },
          "fuel": {
            "type": "number",
            "description": "燃料調整費（円）"
          },
          "renewable_surcharges": {
            "type": "number",
            "description": "再エネ賦課金（円）"
          },
          "total": {
            "type": "number",
            "description": "合計（円）"
          }
        }
      },
      "description": "電気料金"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

月別 設備導入効果額

月別 電気代ランキング
GET/charges/recomend/{?dev_id}

直近3ヶ月の購入電力量の実績から電気料金のランキングを返却します。
毎月月初に更新。

Example URI

GET https://api.enegaeru.com/aisense/charges/recomend/?dev_id=D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "charge_ranking": [
    {
      "epcorp_cd": 4,
      "epcorp_shortname": "東京電力",
      "plan_cd": 1,
      "plan_name": 0,
      "electrical_charges": 5000
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "charge_ranking": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "epcorp_cd": {
            "type": "number",
            "description": "企業ID"
          },
          "epcorp_shortname": {
            "type": "string",
            "description": "企業名"
          },
          "plan_cd": {
            "type": "number",
            "description": "プランCD"
          },
          "plan_name": {
            "type": "number",
            "description": "プラン名称"
          },
          "electrical_charges": {
            "type": "number",
            "description": "電気代（円）"
          }
        }
      },
      "description": "電気料金のランキング"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

マスター系

電気事業者

電気事業者取得
GET/epcorps{?prefecture_cd,zip_cd}

電気事業者の一覧を取得します。
（prefecture_cd, zip_cd は同時に指定できません。）

*都道府県コード
　　北海道　01:北海道
　　東北　　02:青森県, 03:岩手県, 04:宮城県, 05:秋田県, 06:山形県, 07:福島県
　　関東　　08:茨城県, 09:栃木県, 10:群馬県, 11:埼玉県, 12:千葉県, 13:東京都, 14:神奈川県
　　北陸　　15:新潟県, 16:富山県, 17:石川県, 18:福井県
　　中部　　19:山梨県, 20:長野県, 21:岐阜県, 22:静岡県, 23:愛知県
　　近畿　　24:三重県, 25:滋賀県, 26:京都府, 27:大阪府, 28:兵庫県, 29:奈良県, 30:和歌山県
　　中国　　31:鳥取県, 32:島根県, 33:岡山県, 34:広島県, 35:山口県
　　四国　　36:徳島県, 37:香川県, 38:愛媛県, 39:高知県
　　九州　　40:福岡県, 41:佐賀県, 42:長崎県, 43:熊本県, 44:大分県, 45:宮崎県, 46:鹿児島県
　　沖縄　　47:沖縄県

Example URI

GET https://api.enegaeru.com/aisense/epcorps?prefecture_cd=13&zip_cd=1000005
URI Parameters
HideShow
prefecture_cd
string (optional) Example: 13

都道府県コード(01～47)

zip_cd
string (optional) Example: 1000005

郵便番号(ハイフンなし, 7桁)

Response  200
HideShow
Body
[
  {
    "id": "4",
    "epcorp_short_name": "東京電力エナジーパートナー",
    "surplus_selling": "24",
    "after_surplus_selling\"": "8.5",
    "oldepcorp_cd": "4",
    "occtoepcorp_cd": "K003",
    "metiepcorp_cd": "A0269"
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "電気事業者コード"
      },
      "epcorp_short_name": {
        "type": "string",
        "description": "電気事業者名"
      },
      "surplus_selling": {
        "type": "string",
        "description": "FIT期間内余剰売電単価"
      },
      "after_surplus_selling\"": {
        "type": "string",
        "description": "FIT期間後余剰売電単価"
      },
      "oldepcorp_cd": {
        "type": "string",
        "description": "旧電力事業者コード"
      },
      "occtoepcorp_cd": {
        "type": "string",
        "description": "広域機関システムコード"
      },
      "metiepcorp_cd": {
        "type": "string",
        "description": "エネ庁登録番号"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

電気料金プラン

電気料金プラン取得
GET/epplans/{epcorp_cd}/{?contract_type}

電気事業者コードより電気料金プランを取得します。

Example URI

GET https://api.enegaeru.com/aisense/epplans/1/?contract_type=0
URI Parameters
HideShow
epcorp_cd
number (required) Example: 1

電気事業者コード

contract_type
number (required) Example: 0

契約種別 (0:低圧電灯, 1:低圧電力)

Response  200
HideShow
Body
[
  {
    "epcorp_cd": 1,
    "epplan_cd": 1,
    "plan_name": "従量電灯B",
    "period_from": "2001-01-01",
    "period_to": "2999-12-31",
    "contract_type": 0,
    "base_info": [
      {
        "base_name": "従量電灯B",
        "base_cd": 1,
        "ampare": 60,
        "capacity_from": 0,
        "capacity_to": 0,
        "power_factor `0`": 1
      }
    ]
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "epcorp_cd": {
        "type": "number",
        "description": "電気事業者コード"
      },
      "epplan_cd": {
        "type": "number",
        "description": "料金プランコード"
      },
      "plan_name": {
        "type": "string",
        "description": "料金プラン名称"
      },
      "period_from": {
        "type": "string",
        "description": "有効期間 From"
      },
      "period_to": {
        "type": "string",
        "description": "有効期間 To"
      },
      "contract_type": {
        "type": "number",
        "description": "契約種別 (0:低圧電灯, 1:低圧電力)"
      },
      "base_info": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "base_name": {
              "type": "string",
              "description": "基本料金名称"
            },
            "base_cd": {
              "type": "number",
              "description": "基本料金コード"
            },
            "ampare": {
              "type": "number",
              "description": "電流契約の契約アンペア (単位:A) 電流契約以外の場合 0"
            },
            "capacity_from": {
              "type": "number",
              "description": "契約容量下限値 (単位:kVA) から 1減じた値 (0の場合は0)"
            },
            "capacity_to": {
              "type": "number",
              "description": "契約容量上限値 (単位:kVA) 容量制限なしの場合 0"
            },
            "power_factor `0`": {
              "type": "number",
              "description": "低圧電力の力率 (単位:%) 電力契約以外の場合 0"
            }
          }
        },
        "description": "基本料金情報"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

電気料金プラン詳細

電気料金プラン詳細取得
GET/epplans/{epcorp_cd}/{epplan_cd}/{base_cd}

電気事業者コード,料金プランコード、基本料金コードより電気料金プランの単価を含めた詳細情報を取得します。
（特高/高圧プランのみ対象）

Example URI

GET https://api.enegaeru.com/aisense/epplans/1/2/3
URI Parameters
HideShow
epcorp_cd
number (required) Example: 1

電気事業者コード

epplan_cd
number (required) Example: 2

料金プランコード

base_cd
number (required) Example: 3

基本料金コード

Response  200
HideShow
Body
{
  "epcorp_name": "東京電力",
  "base_name": "従量電灯B（60A）",
  "base_unit": 1870,
  "base_type": 1,
  "contract_type": 0,
  "saturday_flg": 0,
  "sunday_flg": 1,
  "holiday_flg": 1,
  "period_from": "2001-01-01",
  "period_to": "2999-12-31",
  "ampare": 60,
  "capacity_from": 0,
  "capacity_to": 0,
  "power_factor `0`": 1,
  "plan_info": "``",
  "fuel_cd": 1,
  "renewable_cd": 1,
  "volumes": [
    {
      "calc_type": 1,
      "cond_cd": 2,
      "cond_name": "従量電灯・一段料金（～120kWh）",
      "calc_order": 1,
      "volume_from": 0,
      "volume_to": 0,
      "month_from": 1,
      "month_to": 12,
      "holiday_data": 0,
      "time_from": 0,
      "time_to": 0,
      "volume_unit": 19.88
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "epcorp_name": {
      "type": "string",
      "description": "基本料金名称"
    },
    "base_name": {
      "type": "string",
      "description": "基本料金名称"
    },
    "base_unit": {
      "type": "number",
      "description": "基本料金単価"
    },
    "base_type": {
      "type": "number",
      "description": "基本料金計算方法 (基本料金計算方法 (1:固定方式, 2:契約容量方式, 3:契約容量超過方式, 4:最低料金方式, 5:ピーク電力容量方式, 6:ピーク電力容量超過方式, 7:ピーク電力固定方式))"
    },
    "contract_type": {
      "type": "number",
      "description": "契約種別 (0:低圧電灯, 1:低圧電力)"
    },
    "saturday_flg": {
      "type": "number",
      "description": "土曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "sunday_flg": {
      "type": "number",
      "description": "日曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "holiday_flg": {
      "type": "number",
      "description": "祝日 休日/平日判定 (0:平日, 1:休日)"
    },
    "period_from": {
      "type": "string",
      "description": "有効期間 From"
    },
    "period_to": {
      "type": "string",
      "description": "有効期間 To"
    },
    "ampare": {
      "type": "number",
      "description": "電流契約の契約アンペア (単位:A) 電流契約以外の場合 0"
    },
    "capacity_from": {
      "type": "number",
      "description": "契約容量下限値 (単位:kVA) から 1減じた値 (0の場合は0)"
    },
    "capacity_to": {
      "type": "number",
      "description": "契約容量上限値 (単位:kVA) 容量制限なしの場合 0"
    },
    "power_factor `0`": {
      "type": "number",
      "description": "低圧電力の力率 (単位:%) 電力契約以外の場合 0"
    },
    "plan_info": {
      "type": "string",
      "description": "追加情報"
    },
    "fuel_cd": {
      "type": "number",
      "description": "燃料調整コード"
    },
    "renewable_cd": {
      "type": "number",
      "description": "再エネ賦課金コード"
    },
    "volumes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calc_type": {
            "type": "number",
            "description": "従量料金計算方法（0：無段階 1：段階制 2:契約容量段階制）"
          },
          "cond_cd": {
            "type": "number",
            "description": "従量条件コード"
          },
          "cond_name": {
            "type": "string",
            "description": "条件名"
          },
          "calc_order": {
            "type": "number",
            "description": "計算順番"
          },
          "volume_from": {
            "type": "number",
            "description": "使用量 From"
          },
          "volume_to": {
            "type": "number",
            "description": "使用量 To 制限なしの場合 0"
          },
          "month_from": {
            "type": "number",
            "description": "月 From"
          },
          "month_to": {
            "type": "number",
            "description": "月 To"
          },
          "holiday_data": {
            "type": "number",
            "description": "休日フラグ (0：区別無し 1：平日 2：休日)"
          },
          "time_from": {
            "type": "number",
            "description": "時間 From"
          },
          "time_to": {
            "type": "number",
            "description": "時間 To"
          },
          "volume_unit": {
            "type": "number",
            "description": "単価"
          }
        }
      },
      "description": "従量条件"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

気象系

気象実績

気象実績取得
GET/weather/actuals/{?dev_id,date}

デバイスID、指定日付から実績データを返します。

Example URI

GET https://api.enegaeru.com/aisense/weather/actuals/?dev_id=D1234567890&date=2022-01-01
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

date
string (required) Example: 2022-01-01

予測起点時刻 YYYY-MM-DD

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "actual_data": [
    {
      "datetime": "2022-01-01 03:00:00",
      "temperature": 17.3,
      "humid": 98,
      "precipitation": 0.7,
      "radiation": 6477
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "actual_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "datetime": {
            "type": "string",
            "description": "実績時刻 YYYY-MM-DD hh:mm:ss"
          },
          "temperature": {
            "type": "number",
            "description": "気温(℃)"
          },
          "humid": {
            "type": "number",
            "description": "湿度(%)"
          },
          "precipitation": {
            "type": "number",
            "description": "降雨量(mm)"
          },
          "radiation": {
            "type": "number",
            "description": "日射量(Wh/m2)"
          }
        }
      },
      "description": "実績データ 時間毎"
    }
  },
  "required": [
    "dev_id",
    "actual_data"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

気象予測

気象予測取得
GET/weather/forecast/{?dev_id,initial_datetime}

デバイスID、予測起点時刻からの予測データを返します。
予測詳細 http://www.jmbsc.or.jp/jp/online/file/f-online10200.html

Example URI

GET https://api.enegaeru.com/aisense/weather/forecast/?dev_id=D1234567890&initial_datetime=202201010300
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

initial_datetime
string (optional) Example: 202201010300

予測起点時刻 YYYYMMDDHHmm (無指定の場合は 最新の予測起点時刻の予測データを返す)

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "forecastl_data": [
    {
      "datetime": "2022-01-01 04:00:00",
      "temperature": 17.3,
      "humid": 98,
      "precipitation": 0.7,
      "radiation": 6477
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "forecastl_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "datetime": {
            "type": "string",
            "description": "予測対象時刻 YYYY-MM-DD hh:mm:ss"
          },
          "temperature": {
            "type": "number",
            "description": "気温(℃)"
          },
          "humid": {
            "type": "number",
            "description": "湿度(%)"
          },
          "precipitation": {
            "type": "number",
            "description": "後1時間降雨量(mm)"
          },
          "radiation": {
            "type": "number",
            "description": "後1時間日射量(Wh/m2)"
          }
        }
      },
      "description": "予測データ"
    }
  },
  "required": [
    "dev_id",
    "forecastl_data"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

気象警報

気象警報取得
GET/weather/warn/{?dev_id}

デバイスIDからの気象警報データを返します。

Example URI

GET https://api.enegaeru.com/aisense/weather/warn/?dev_id=D1234567890
URI Parameters
HideShow
dev_id
string (required) Example: D1234567890

デバイスID

Response  200
HideShow
Body
{
  "dev_id": "D1234567890",
  "datetime": "2022-01-01 04:00:00",
  "warn_data": [
    {
      "1": 2,
      "2": 2,
      "3": 2,
      "4": 2,
      "5": 2,
      "6": 2,
      "7": 2,
      "8": 2,
      "9": 2
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "dev_id": {
      "type": "string",
      "description": "デバイスID"
    },
    "datetime": {
      "type": "string",
      "description": "発表時刻 YYYY-MM-DD hh:mm:ss"
    },
    "warn_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "1": {
            "type": "number",
            "description": "大雨(土砂災害、浸水害) 2:警報  3:特別警報"
          },
          "2": {
            "type": "number",
            "description": "大雨(土砂災害) 2:警報  3:特別警報"
          },
          "3": {
            "type": "number",
            "description": "大雨(浸水害) 2:警報  3:特別警報"
          },
          "4": {
            "type": "number",
            "description": "洪水 2:警報  3:特別警報"
          },
          "5": {
            "type": "number",
            "description": "暴風 2:警報  3:特別警報"
          },
          "6": {
            "type": "number",
            "description": "暴風 2:警報  3:特別警報"
          },
          "7": {
            "type": "number",
            "description": "大雪 2:警報  3:特別警報"
          },
          "8": {
            "type": "number",
            "description": "波浪 2:警報  3:特別警報"
          },
          "9": {
            "type": "number",
            "description": "高潮 2:警報  3:特別警報"
          }
        }
      },
      "description": "警報データ 警報の種類が複数ある場合は発表順に記述する。"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

気象警報リスト

気象警報リスト 取得
GET/weather/warn_types

気象警報のリストを返します。

Example URI

GET https://api.enegaeru.com/aisense/weather/warn_types
Response  200
HideShow
Body
{
  "datetime": "2022-01-01 04:00:00",
  "warn_data": [
    {
      "1": "大雨(土砂災害、浸水害)",
      "2": "大雨(土砂災害)",
      "3": "大雨(浸水害)",
      "4": "洪水",
      "5": "暴風",
      "6": "暴風",
      "7": "大雪",
      "8": "波浪",
      "9": "高潮"
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "datetime": {
      "type": "string",
      "description": "リスト更新日時 YYYY-MM-DD hh:mm:ss"
    },
    "warn_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "1": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "2": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "3": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "4": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "5": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "6": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "7": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "8": {
            "type": "string",
            "description": "固定値 警報種類"
          },
          "9": {
            "type": "string",
            "description": "固定値 警報種類"
          }
        }
      },
      "description": "警報リストの情報"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

その他

トークン生成

トークン生成
POST/generate_auth_token/

ユーザーIDとパスワードまたは機器IDとパスワードでトークン発行 有効期限 24時間

Example URI

POST https://api.enegaeru.com/aisense/generate_auth_token/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "user0000",
  "password": "Password"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "ユーザー名又はデバイス固有番号"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    }
  },
  "required": [
    "username",
    "password"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "uid": "AQxCxxgKnxxLLhxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "info": {
    "id": "1234567890",
    "name": "user0000"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "アクセストークン（API call時は Header の Authorization に この値をセットします）"
    },
    "info": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ユーザーID又はデバイスID"
        },
        "name": {
          "type": "string",
          "description": "ユーザー名 又はデバイス固有番号"
        }
      }
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "エラーメッセージ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（パラメータエラー等のリクエストエラー）"
        }
      }
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Internal Server Error"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "エラーメッセージ（システム内部における異常発生時）"
        }
      }
    }
  }
}

Generated by aglio on 07 Mar 2022