Key｜Route B 服務開通

通用性說明

送審流程

  • 台灣時間每天 23:00 送審，並且檢查前一天送審結果。

  • 更新時間 大於前一日 23 : 00 且 送審未成功 的案件會進行審查。

  • http response 中 applResult 的 value

結果

可能內容

送審成功

成功

送審失敗

用電戶名不符
※ NextDrive 僅遇過一次送審失敗，推測應有其他失敗內容

API Domain 與認證

https://api-eg3.nextdrive.io

採取 API Key 認證，請於 Request Header 添加 `Authorization: Bearer <API_KEY>`

Route B 服務開通

API ① - 申請開通 Route B 服務

Summary

申請開通 Route B

Path

POST /api/v1/taipowermeters

Description

在呼叫此 API 後，聯齊將代替 SI 向台電業務處申請開通 Route B 服務，並提供：

  1. 用戶申請代碼

  2. 電度表資料使用同意書（圖檔）上傳的 URL

Request Body

Content Type

application/json

Example Value
JSON
{
  "userName": "王大明",
  "identity": "A12345678",
  "email": "example@nextdrive.io",
  "phone": "091234567",
  "tpcNo": "01736405682",
  "openDatetime": "2011-10-05T14:48:00.000Z"
}

Schema
JSON
{
  "userName": string (用戶姓名) | required,
  "identity": string (身分證字號/統一編號) | required,
  "email": string (email 格式) | required,
  "phone": string (手機或市話，無須用-間隔) | required,
  "tpcNo": string (11碼台電電號) | required,
  "openDatetime": ISO date string (開再封印日期) | required
}

Note

再開封印日期說明

  • 台電未限制填寫時間，聯齊實際執行經驗如下：

    1. 原則填寫上班日

    2. 填寫現場完工日當天（可當天完成施工）或隔天（無法當天完成施工）

  • 再開封印日期送出後如需調整，須直接聯繫負責區處進行溝通

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "hemsNo": "N01113394"
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "hemsNo": string
  }
}

Note

  • 電度表資料使用同意書（圖檔）上傳 URL 有效時效為 60 分鐘

Response

Status Code

403

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 40305,
  "message": "application existed",
  "data": {
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
  }
}

Note

若 identity 與 tpcNo 重複，將顯示該筆申請已存在

API ② - 上傳同意書圖片

Summary

上傳同意書圖片

Path

POST /api/v1/taipowermeters/{hemsNo}/agreeImage

Description


Request Body

Content Type

multipart/form-data

Example Value
JSON
image=<image file>

Schema
JSON
image=<image file>

Request Params

Example Value
JSON
hemsNo: "20250402-0001"

Schema
JSON
hemsNo: string(NextDrive defined DSN)

Note

僅支援 JPG 格式圖片

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "url": "<agreeImageUrl>"
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "url": string
  }
}

Note

  • 顯示圖片的 Image URL 具時效性1個小時

Response

Status Code

400

Description

Invalid parameter.

Content Type

application/json

Example Value
JSON
{
  "code": 40000,
  "message": "Invalid parameter: XXXXXX"
}

Schema
JSON
{
  "code": integer,
  "message": string
}

Note

  1. Upload file minetype is only allowed to be image/jpeg.

  2. Unexpected image files, please check your request body

Response

Status Code

403

Description

Forbidden.

Content Type

application/json

Example Value
JSON
{
  "code": 40301,
  "message": "Image Existed"
}

Schema
JSON
{
  "code": integer,
  "message": string
}

Response

Status Code

404

Description

Resource not found.

Content Type

application/json

Example Value
JSON
{
  "code": 40301,
  "message": "Not found: hemsNo 20250319-0005 not found"
}

Schema
JSON
{
  "code": integer,
  "message": string
}

API ③ - 上傳附件圖片

Summary

上傳附件圖片

Path

POST /api/v1/taipowermeters/{hemsNo}/attachmentImage

Description


Request Body

Content Type

multipart/form-data

Example Value
JSON
image=<image file>

Schema
JSON
image=<image file>

Request Params

Example Value
JSON
hemsNo: "20250402-0001"

Schema
JSON
hemsNo: string(NextDrive defined DSN)

Note

  • 僅支援 JPG 格式圖片

  • 若單一個場域有多個電號（通常是一棟大樓但地址不同），則需要按電號分別申請電度表資料使用同意書、檢附對應的附件圖片

  • 各同意書實際上傳的附件圖片，可使用相同的圖檔（將所有電號/地址/統編的清單列出）

    image-20241210-092728.png

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "url": "<attachmentImage>"
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "url": string
  }
}

Note

  • 顯示圖片的 Image URL 具時效性1個小時

Response

Status Code

400

Description

Invalid parameter.

Content Type

application/json

Example Value
JSON
{
  "code": 40000,
  "message": "Invalid parameter: XXXXXX"
}

Schema
JSON
{
  "code": integer,
  "message": string
}

Note

  1. Upload file minetype is only allowed to be image/jpeg.

  2. Unexpected image files, please check your request body

Response

Status Code

403

Description

Forbidden.

Content Type

application/json

Example Value
JSON
{
  "code": 40301,
  "message": "Image Existed"
}

Schema
JSON
{
  "code": integer,
  "message": string
}

Response

Status Code

404

Description

Resource not found.

Content Type

application/json

Example Value
JSON
{
  "code": 40301,
  "message": "Not found: hemsNo 20250319-0005 not found"
}

Schema
JSON
{
  "code": integer,
  "message": string
}


API ④ - 更新 Route B 服務開通的申請資訊

Summary

更新 Route B 服務開通的申請資訊

Path

PUT /api/v1/taipowermeters/{hemsNo}

Description

在呼叫此 API 後，可更新 Route B 服務開通的申請資訊

Request Body

Content Type

application/json

Example Value
JSON
{
  "userName": "王大明",
  "identity": "A12345678",
  "email": "example@nextdrive.io",
  "phone": "091234567",
  "tpcNo": "01736405682",
  "openDatetime": "2011-10-05T14:48:00.000Z"
}

Schema
JSON
{
  "userName": string (用戶姓名) | required,
  "identity": string (身分證字號/統一編號) | required,
  "email": string (email 格式) | required,
  "phone": string (手機或市話，無須用-間隔) | required,
  "tpcNo": string (11碼台電電號) | required,
  "openDatetime": ISO date string (開再封印日期) | required
}

Request Params

Example Value
JSON
hemsNo: "20250402-0001"

Schema
JSON
hemsNo: string(NextDrive defined DSN)

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "hemsNo": "<用戶申請代碼>",
    "applNo": "<受理編號>"
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "hemsNo": string,
    "applNo": string
  }
}

Note

  • 電度表資料使用同意書（圖檔）上傳 URL 有效時效為 60 分鐘

Response

Status Code

403

Description

Forbidden.

Content Type

application/json

Example Value
JSON
{
  "code": 43000,
  "message": "forbidden: hemsNo 20250319-0004 is not existed or already approved."
}

Schema
JSON
{
  "code": integer,
  "message": string
}

API ⑤ - 取得 Route B 服務開通的申請結果

Summary

取得 Route B 服務開通的申請結果

Path

GET /api/v1/taipowermeters/{hemsNo}

Description

在呼叫此 API 後，聯齊將提供 Route B 服務開通的申請結果

Request Body

Content Type

application/json

Example Value
JSON
N/A

Schema
JSON
N/A

Request Params

Example Value
JSON
hemsNo: "20250402-0001"

Schema
JSON
hemsNo: string(NextDrive defined DSN)

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "hemsNo": "<用戶申請代碼>",
    "applNo": "<受理編號>",
    "userName": "<用電戶名>",
    "identity": "<身分證字號/統一編號>",
    "email": "<電子郵件>",
    "phone": "<行動電話>",
    "tpcNo": "<電號>",
    "openDatetime": "<開再封印日期>",
    "createdDatetime": "<申請時間>",
    "uploadToFtpDatetime": "<上傳 ftp 時間>",
    "applResult": "<審核結果>",
    "agreeImageUrl": "<同意書圖片上傳之 URL>",
    "attachmentImageUrl": "<附件圖片上傳之 URL>"
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "hemsNo": string,
    "applNo": string,
    "userName": string,
    "identity": string,
    "email": string,
    "phone": string,
    "tpcNo": string,
    "openDatetime": ISO date string,
    "createdDatetime": ISO date string,
    "uploadToFtpDatetime": ISO date string,
    "applResult": string,
    "agreeImageUrl": string,
    "attachmentImageUrl": string
  }
}

Note


API ⑥ - 取得 Route B 服務開通的申請清單與結果

Summary

取得 Route B 服務開通的申請清單與結果

Path

GET /api/v1/taipowermeters?page={pageNo}

Description

在呼叫此 API 後，聯齊將提供 Route B 服務開通的申請清單與結果

Request Body

Content Type

application/json

Example Value
JSON
N/A

Schema
JSON
N/A

Request Params

Example Value
JSON
pageNo: "1"

Schema
JSON
pageNo: "integer"

Note

依時間排序，新的在前就得在後

再開封印日期說明

  • 台電未限制填寫時間，聯齊實際執行經驗如下：

    1. 原則填寫上班日

    2. 填寫現場完工日當天（可當天完成施工）或隔天（無法當天完成施工）

  • 再開封印日期送出後如需調整，須直接聯繫負責區處進行溝通

Response

Status Code

200

Description

Success

Content Type

application/json

Example Value
JSON
{
  "code": 20000,
  "message": "Successful request",
  "data": {
    "page": "<第幾頁>",
    "totalSize": "<總筆數>",
    "list": [
      {
        "hemsNo": "<用戶申請代碼>",
        "applNo": "<受理編號>",
        "userName": "<用電戶名>",
        "identity": "<身分證字號/統一編號>",
        "email": "<電子郵件>",
        "phone": "<行動電話>",
        "tpcNo": "<電號>",
        "openDatetime": "<開在封印日期>",
        "createdDatetime": "<申請時間>",
        "uploadToFtpDatetime": "<上傳 ftp 時間>""file1": "<檔案 1>",
        "applResult": "<審核結果>",
        "agreeImageUrl": "<同意書圖片上傳之 URL>",
        "attachmentImageUrl": "<附件圖片上傳之 URL>"
      }
    ]
  }
}

Schema
JSON
{
  "code": integer,
  "message": string,
  "data": {
    "page": integer,
    "totalSize": integer,
    "list": [
      {
        "hemsNo": string,
        "applNo": string,
        "userName": string,
        "identity": string,
        "email": string,
        "phone": string,
        "tpcNo": string,
        "openDatetime": ISO date string,
        "createdDatetime": ISO date string,
        "uploadToFtpDatetime": ISO date string,
        "applResult": string,
        "agreeImageUrl": string,
        "attachmentImageUrl": string
      }
    ]
  }
}

Note