經濟部商工行政資料開放平臺開發指引
本平臺開放資料提供
原始檔案下載、
系統介接API兩種方式供開發人員取得及使用。
一、原始檔案下載
建議適用對象:欲取得「公司登記」或「商業登記」之民眾。
詳見上排選單的「資料目錄」內點選 「公司登記資料」或「商業登記資料」。由各資料集頁面內下載原始檔案資料(資料格式皆為csv檔案)。
二、系統介接API
建議適用對象:欲取得「公司登記」或「商業登記」之程式開發者。
詳見上排選單的「資料目錄」內點選 「公司登記介接」或「商業登記介接」。由各資料集頁面內點選Json或XML,以檢視該API介接指引說明。
以下提供本平臺之公開資料清單下載:
1.經濟部商業發展署開放資料供應清單
[經濟部商業發展署開放資料供應清單.xls][經濟部商業發展署開放資料清單.ods]
2.經濟部商業發展署開放資料供應清單(僅含API)
[經濟部商業發展署開放資料供應清單(僅含API).xls][經濟部商業發展署開放資料清單(僅含API).ods]
系統介接API介接指引
一、申請流程說明
1.可於上排選單的「資料目錄」內點選 「公司登記介接」或「商業登記介接」查看,或下載經濟部商業發展署開放資料供應清單(僅含API)
[經濟部商業發展署開放資料供應清單(僅含API).xls][經濟部商業發展署開放供應資料清單(僅含API).ods]比對各項API,挑選出適合介接使用者之API項目。
2.為確保平臺服務品質與維持系統效能,使用系統介接API之單位或個人請填寫使用告知書。
[經濟部商工行政資料開放平臺資料介接使用告知書.doc][經濟部商工行政資料開放平臺資料介接使用告知書.odt]
3.填寫完告知書,請向計畫維運團隊遞件。聯絡信箱為:opendata.gcis@gmail.com。
4.本平臺在收到告知信件確認資料無誤後(*註一),會進行介接設定並發信通知告知者該介接設定已完成。
*註一: 本平臺系統介接API係透過來源IP進行白名單管控,請告知者務必於告知書內填寫外部IP,而非內部IP。
二、為提供穩定之服務環境,維持各項服務之可用性,本平臺針對系統介接API進行「使用量管制」。管制內容如下:
檢查項目 |
超出限制時,回應之異常訊息 |
本平臺最大總連線數量 |
本平臺介接服務達上限,請稍候再試。 |
介接使用者同時最大連線數量 |
超出同時最大連線數量。 |
介接使用者每日最大介接次數 |
超出本日最大介接次數。 |
三、本平臺針對「系統介接API(以下簡稱API)使用的常見問題」,進行回應處理。以下為回應之訊息:
檢查項目 |
API使用方式之回應異常訊息 |
暫時停止API服務 |
資料庫維護中,暫時停止API服務。 |
此API不存在 |
此API不存在,請查明後繼續。 |
未向維運團隊提出告知或提出告知之IP不正確 |
非授權介接之IP(xxx.xxx.xxx.xxx),請查明後繼續。 |
此API不開放 |
此API不開放使用。 |
$format空白或錯誤 |
$format參數有誤,請查明後繼續。 |
$filter空白或錯誤 |
$filter參數有誤,請查明後繼續。 |
各項API介接使用說明