校園食材登錄平臺 OpenAPI

服務根網址: fatraceschool.moe.gov.tw/cateringservice/openapi, 版本號碼: v1

校園食材登錄平臺 OpenAPI

傳輸協定: https
OPENAPI定義檔 OPENAPI操作說明

摘要

HTTP請求方法與API路徑 說明
POST /accountReg/

帳號登錄取得openapi存取碼

Request
{
"account": "johndoe@gmail.com"
}
Response
{
"message": "帳號登錄成功,請至您的電子郵件信箱收取openapi存取碼"
}

HTTP請求方法與API路徑 說明
POST /county/

查詢縣市名稱

Request
{
"accesscode": "dcd78f628520181029182043"
}
Response
{
"message": "openapi查詢縣市名稱成功",
"countyList": [
"臺南市"
]
}

HTTP請求方法與API路徑 說明
POST /opendatadataset/

查詢opendata資料集與食材中文名稱資料集

Request
{
"accesscode": "dcd78f628520181029182043",
"year": "2018",
"month": "02",
"county": "臺南市"
}
Response
{
"message": "openapi查詢opendata縣市資料集成功",
"datasetList": [
{
"year": "2018",
"month": "02",
"county": "臺南市",
"grade": "國中小",
"datasetname": "午餐食材及供應商資料集",
"createdate": "2018/10/26"
},
{
"year": "2018",
"month": "02",
"county": "全國",
"grade": "國中小",
"datasetname": "午餐食材及供應商資料集",
"createdate": "2018/10/26"
}
]
}

HTTP請求方法與API路徑 說明
POST /opendatadownload/

取得資料集下載連結

Request
{
"accesscode": "dcd78f628520181029182043",
"year": "2018",
"month": "02",
"county": "臺南市"
"grade": "國中小",
"datasetname": "午餐食材及供應商資料集"
}
Response
{
"message": "openapi取得opendata縣市資料集下載連結成功",
"year": "2018",
"month": "02",
"county": "臺南市"
"grade": "國中小",
"datasetname": "午餐食材及供應商資料集"
"link": "https://fatraceschool.moe.gov.tw/cateringservice/web/ openapi_download/201802_臺南市國中小午餐食材及供應商資料集20181105171052.csv"
}

API路徑

帳號登錄取得openapi存取碼

POST /accountReg/

標籤: accountRegApi

輸入帳號(電子郵件信箱地址)向系統登錄,openapi存取碼會透過電子郵件寄送至該信箱

電子郵件信箱地址

application/json

200 OK

系統回應訊息

查詢縣市名稱

POST /county/

標籤: countyApi

輸入openapi存取碼,取得opendata全國縣市名稱資料

openapi存取碼

application/json

200 OK

系統回應訊息與opendata全國縣市名稱資料

查詢opendata資料集與食材中文名稱資料集

POST /opendatadataset/

標籤: opendatadatasetApi

輸入openapi存取碼、年、月、縣市名稱,取得opendata資料集與食材中文名稱資料集資料

openapi存取碼、年、月、縣市名稱

application/json

200 OK

系統回應訊息與opendata資料集與食材中文名稱資料集資料

取得資料集下載連結

POST /opendatadownload/

標籤: opendatadownloadApi

輸入openapi存取碼、年、月、縣市名稱、學級名稱、資料集名稱,取得資料集下載連結

openapi存取碼、年、月、縣市名稱、學級名稱、資料集名稱

application/json

200 OK

系統回應訊息與資料集下載連結

物件定義

accountRegReq: 物 件

account: 字串

說明 : 電子郵件信箱地址

"johndoe@gmail.com"
                                                        

accountRegResp: 物 件

message: 字串

說明 : openapi回應訊息

"帳號登錄成功,請至您的電子郵件信箱收取openapi存取碼"
                                                        

countyReq: 物 件

accesscode: 字串

說明 : openapi存取碼

"dcd78f628520181029182043"
                                                        

countyResp: 物 件

message: 字串

說明 : openapi回應訊息

"openapi查詢縣市名稱成功"
                                                        
countyList: 字串陣列
字 串

說明 : 縣市名稱

"臺南市"
                                                                                

opendatadataset: 物 件

year: 字串

說明 : 年

"2018"
                                                        
month: 字串

說明 : 月

"02"
                                                        
county: 字串

說明 : 縣市名稱

"臺南市"
                                                        
grade: 字串

說明 : 學級名稱

"國中小"
                                                        
datasetname: 字串

說明 : 資料集名稱

"午餐食材及供應商資料集"
                                                        
createdate: 字串

說明 : 資料集產生日期

"2018/10/26"
                                                        

opendatadatasetReq: 物 件

accesscode: 字串

說明 : openapi存取碼

"dcd78f628520181029182043"
                                                        
year: 字串

說明 : 年

"2018"
                                                        
month: 字串

說明 : 月

"02"
                                                        
county: 字串

說明 : 縣市名稱

"臺南市"
                                                        

opendatadatasetResp: 物 件

message: 字串

說明 : openapi回應訊息

"openapi查詢opendata縣市資料集成功"
                                                        
datasetList: 物件陣列

opendatadownloadReq: 物 件

accesscode: 字串

說明 : openapi存取碼

"dcd78f628520181029182043"
                                                        
year: 字串

說明 : 年

"2018"
                                                        
month: 字串

說明 : 月

"02"
                                                        
county: 字串

說明 : 縣市名稱(若下載全國資料集或調味料或團膳業者或食材中文名稱資料集,此欄位請填全國或填空白)

"臺南市"
                                                        
grade: 字串

說明 : 學級名稱(若下載調味料或團膳業者或食材中文名稱資料集,此欄位請填空白)

"國中小"
                                                        
datasetname: 字串

說明 : 資料集名稱

"午餐食材及供應商資料集"
                                                        

opendatadownloadResp: 物 件

message: 字串

說明 : openapi回應訊息

"openapi取得opendata縣市資料集下載連結成功"
                                                        
year: 字串

說明 : 年

"2018"
                                                        
month: 字串

說明 : 月

"02"
                                                        
county: 字串

說明 : 縣市名稱

"臺南市"
                                                        
grade: 字串

說明 : 學級名稱

"國中小"
                                                        
datasetname: 字串

說明 : 資料集名稱

"午餐食材及供應商資料集"
                                                        
link: 字串

說明 : 資料集下載連結

"https://fatraceschool.moe.gov.tw/cateringservice/web/openapi_download/201802_臺南市國中小午餐食材及供應商資料集20181105171052.csv"