OPEN API 專區
API PROJECT
API 介接說明
海洋棲地
海草床
水產動植物保育區
監測技術
人工濕地
API 介接說明
1.本平台提供透過API介接海洋及濕地碳儲存資料庫，因本平台採用會員服務機制，需帶入帳號之API金鑰，方可啟用服務。
2.請點選下方建立金鑰
3.平台帳號綁訂對應API金鑰請妥善保管
2.請點選下方建立金鑰
3.平台帳號綁訂對應API金鑰請妥善保管
api_key （apiKey）
若您有註冊會員，可輸入您的API_KEY值增加每日可查詢筆數
Name： api_key
In： api_key
若您有註冊會員，可輸入您的API_KEY值增加每日可查詢筆數
Name： api_key
In： api_key
*非會員則有使用api次數限制
Schemes
Value
海洋棲地
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
GET
取得海洋棲地資料
/CarbonSink/list
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
POST
新增海洋棲地資料
/CarbonSink/1
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
PUT
編輯海洋棲地資料
/CarbonSink/1
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
DELETE
刪除海洋棲地資料
/CarbonSink/{id}
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
海草床
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
GET
取得海草床資料
/CarbonSink/list
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
POST
新增海草床資料
/CarbonSink/2
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
PUT
編輯海草床資料
/CarbonSink/2
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
DELETE
刪除海草床資料
/CarbonSink/{id}
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
水產動植物保育區
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
GET
取得水產動植物保育區資料
/CarbonSink/list
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
POST
新增水產動植物保育區資料
/CarbonSink/3
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
PUT
編輯水產動植物保育區資料
/CarbonSink/3
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
DELETE
刪除水產動植物保育區資料
/CarbonSink/{id}
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
監測技術
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
GET
取得監測技術資料
/CarbonSink/list
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
POST
新增監測技術資料
/CarbonSink/4
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
PUT
編輯監測技術資料
/CarbonSink/4
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
DELETE
刪除監測技術資料
/CarbonSink/{id}
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
人工濕地
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
Request
Response
Sample
GET
取得人工濕地資料
/CarbonSink/list
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
POST
新增人工濕地資料
/CarbonSink/5
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
PUT
編輯人工濕地資料
/CarbonSink/5
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample
DELETE
刪除人工濕地資料
/CarbonSink/{id}
Request
| Name | Type | Required | DefaultValue | Description |
|---|---|---|---|---|
| id | Guid | true | null | 表單編號 |
| name | String | false | null | 表單名稱 |
Response
| Code | Descripition |
|---|---|
| 200 | 成功 |
| 401 | 沒有權限 |
| 500 | 伺服器發生錯誤 |
Sample