服務提供流程說明
您可以點選以下步驟，直接快速連結到想瞭解的步驟。
Step1
1.API輸入設計
協作平台定義可登錄的服務類型共有三類，包括API、WMS及WFS等，WMS、WFS可透過GIS軟體(例如:ArcGIS Server、GeoServer等)自行發布，API則需由系統開發人員協助開發。
API輸入介面設計
| GET– 傳遞要查詢的方法 |
| mode |
描述：由提供端自行設計的查詢介面名稱。
型別：英數字。 |
| moisn |
描述：執行序號，由平台產生的交易序號，方便日後查詢相關交易紀錄使用。
型別：英數字。 |
| POST – 傳遞要查詢的參數內容 |
| Body |
描述：描述 mode指定的介面所需的參數。
型別：application/JSON |
| 呼叫範例 |
http://127.0.0.1/example?mode=query&moisn=CFAF0A6012B4492797E93F9D2355DF4A
|
| 輸入範例 |
{
"CITY" : "A",
"TOWN" : "01"
}
|
2.API輸出設計
API輸入介面設計
| 名稱 |
型別 |
描述 |
| STATUS |
數字 |
服務執行結果，1為成功，0為失敗。 |
| CODE |
數字 |
訊息代碼，當STATUS為0時，此欄位應回傳對應的錯誤代碼。
|
| MESSAGE
|
文字
|
此欄位配合CODE所記載的錯誤代碼，描述錯誤的補充資訊，供使用者參考。
|
| TRANSACTIONID
|
文字 |
交易履歷編號，提供介接端以此編號查詢單次交易的所有相關紀錄資訊。 |
| RETURNROWS |
數字 |
回傳的資料筆數，此數字依據各服務對於資料筆數的計算邏輯進行回傳，供平台記錄保存。 |
| QUANTITY |
數字 |
資料回傳的有效筆數，此數字依據各服務有值回傳(例：有效地號)的資料筆數進行計算。 |
| PRICE |
數字 |
本次介接費用計算。 |
| RESPONSE |
文字 |
服務執行的結果，需為JSON格式，由提供端自行決定內容。 |
| CODE代碼 |
代碼說明 |
| 201 |
無效的介面名稱 |
| 202 |
無效的介面參數，參數應使用JSON結構
|
| 203 |
缺少必要的參數，請參閱MESSAGE所記載的參數 |
| 301 |
必要參數內容不應為空白，請參閱MESSAGE所記載的參數 |
| 302 |
參數格式錯誤，請參閱MESSAGE所記載的參數 |
| 401 |
網路發生錯誤，無法完成服務執行 |
| 402 |
系統資料庫異常，請參閱MESSAGE所記載的詳細錯誤 |
| 999 |
其他錯誤，請參閱MESSAGE所記載內容 |
輸出範例
3.API測試介面
API須提供測試介面，此介面主要提供平台進行自動健康檢測，目的在確保各API是否正常運作。
| GET |
| mode |
Test |
| POST |
| Body |
{
"SN" : "序號",
"Time" : "測試時間"
}
|
| 回應格式 |
| SN |
接收到的序號 |
| Time |
接收到的時間欄位內容 |
| ReceiveTime |
接收測試時的本地時間 |
| 呼叫範例 |
http://127.0.0.1/sample?mode=Test |
| 輸入結構 |
{
"SN" : "143545C6F6E64BEA8F6B2840E59C3D61",
"Time" : "2016-09-28 15:55:20"
}
|
| 回應範例 |
{
"STATUS" : "1",
"MESSAGE" : null,
"TRANSACTIONID": null,
"RETURNROWS": 1,
"QUANTITY": 1,
"PRICE": 1,
"RESPONSE" :
[{
"SN" : "143545C6F6E64BEA8F6B2840E59C3D61",
"Time" : "2016-09-28 15:55:20",
"ReceiveTime" : "2016-09-28 15:55:21"
}]
}
|
4.開發範例
範例使用Visual Studio 2012開發，以C#語言編寫，後端以CSV為服務資料來源
Step2
1.使用憑證註冊
點選會員登入，點選註冊帳號，並備妥您的憑證與讀卡機，進行憑證驗證。（憑證類型包含：自然人憑證、組織憑證、工商憑證與機關憑證）
2.填寫會員資訊
會員帳號以電子郵件帳號為主要識別依據，若為公務人員請務必使用公務郵件信箱進行註冊，每張憑證可申請 1 組帳號。系統將自動帶入E政府所登錄的基本資料，部分欄位可自行修改。
在送出註冊單前，請務必閱讀【個人資料蒐集同意書】，並按下核取方塊，確認同意本平台可儲存使用者的相關資料。
3.電子信箱驗證
系統將寄送啟用通知信至使用者的電子郵件信箱，點選郵件內附的連結，確認信箱正確後開通帳號。
Step3
1.選擇供應方式
依據服務的供應用方式，可區分為開放介接、代管介接。
| 開放介接 |
代管介接 |
| 平台協助揭露服務的資訊內容，並提供服務的實際網址給予使用者自行呼叫。 |
平台協助揭露服務的資訊內容，使用者須經由平台服務方可對該服務進行介接。 |
 |
 |
2.服務介面檢測
為確保服務介面的一致性，服務應通過平台的介面檢測方可進行登錄。
API介面檢測主要以平台規範的【API測試介面】為主，以確認該服務是否遵循規範來實作。
3.登錄服務資訊
服務英文名稱則為平台識別該服務的唯一值，因此不可與其他服務重複。另外亦提供收
4.登錄介面資訊
使用者透過平台提供的介面編輯功能設定介面資訊，平台可透過此資訊來檢核所有介面服務的呼叫是符合服務的設計。
