---
# System prepended metadata

title: 廠商要提供的資料（精簡版）

---

# 廠商要提供的資料（精簡版）
:::warning 
注意事項
- 所有與程式碼有關之區塊，皆須有 syntax highlight 並有醒目之區塊提示（可參考下面範例）
:::
## 各項 API 詳細內容

:::info
每個API 說明都需要包含以下資訊
:::
### 基本資訊
- API 名稱
- Http method 
- API 路徑

### Response
- 回傳資料欄位說明
    | name | detail               |
    | ---- |:-------------------- |
    | Text | 解釋的越**詳細**越好 |
- Error Response Example
    需要詳細列出所有會遇到的 Error Code，並說明原因
    :::info
    每個 API Error Code 都需要包含以下資訊
    :::
    - 請**詳細**說明錯誤原因  
    - Http Status Code
    - Example Response 
        ```json
        HTTP/1.1 401 Unauthorized
        Transfer-Encoding: chunked
        Content-Type: application/json; charset=utf-8
        Server: Microsoft-IIS/7.5
        X-Powered-By: ASP.NET
        Date: Mon, 12 Dec 2022 06:46:25 GMT
        Connection: close

        {
          "code": 2,
          "msg": "Wrong account or password",
          "data": null
        }
        ```
    
