# SSCMS REST API

SSCMS REST API 為 SSCMS 提供了一個基于 HTTP 的 API 調用，允許開發者通過發送和接收 JSON 對象來遠程與站點進行交互。JSON 是一種開放的標準數據格式，它是輕量級的，而且是人類可讀的。

當向 API 發送內容或請求時，響應將以 JSON 形式返回，這使開發人員能夠從客戶端 JavaScript 或外部應用程序創建、讀取和更新 SSCMS 內容，REST API 可以使用任何編程語言進行調用。

TIP

可以通過 http://<example.com>/api/docs/（需要將 example.com 替換為真實域名或IP地址）訪問 SSCMS 生成的 Swagger API 文檔。

# 為什么使用 REST API ?

SSCMS REST API 提供了一組易于使用的 HTTP 端點，可以讓您以簡單的 JSON 格式訪問站點的數據，包括站點、欄目、內容等等。檢索或更新數據就像發送 HTTP 請求一樣簡單。

SSCMS REST API 使開發者比以往更容易獲取站點數據，通過使用 REST API，您可以更容易地構造您想要從 SSCMS 中獲取數據的方式。使用 REST API 可以極大地簡化 AJAX 調用，使您能夠更少地花時間訪問所需的數據，并花更多時間創建更好的用戶體驗。

你可以創建一個應用來為 SSCMS 提供一個全新的管理界面，或創造一個全新的交互式前端體驗，任何能夠生成 HTTP 請求和解釋 JSON 的編程語言都可以通過 REST API 與 SSCMS 交互。

SSCMS REST API 通過 URL 地址提供訪問接口，為了測試是否能夠訪問 SSCMS REST API，你可以簡單地用瀏覽器打開地址：

http://<example.com>/api/ping/（需要將 example.com 替換為真實域名或IP地址）

如果請求成功，SSCMS REST API 將從服務器返回字符串 pong。

操作	請求	地址
獲取內容列表 API	POST	/api/v1/contents
獲取內容 API	GET	/api/v1/contents/{siteId}/{channelId}/{id}
新增內容 API	POST	/api/v1/contents/{siteId}/{channelId}
修改內容 API	PUT	/api/v1/contents/{siteId}/{channelId}/{id}
刪除內容 API	DELETE	/api/v1/contents/{siteId}/{channelId}/{id}
審核內容 API	POST	/api/v1/contents/check

操作	請求	地址
獲取欄目列表 API	GET	/api/v1/channels/{siteId}
獲取欄目 API	GET	/api/v1/channels/{siteId}/{channelId}
新增欄目 API	POST	/api/v1/channels/{siteId}
修改欄目 API	PUT	/api/v1/channels/{siteId}/{channelId}
刪除欄目 API	DELETE	/api/v1/channels/{siteId}/{channelId}

操作	請求	地址
新增管理員 API	POST	/api/v1/administrators
修改管理員 API	PUT	/api/v1/administrators/{id}
刪除管理員 API	DELETE	/api/v1/administrators/{id}
獲取管理員 API	GET	/api/v1/administrators/{id}
獲取管理員列表 API	GET	/api/v1/administrators
管理員登錄 API	POST	/api/v1/administrators/actions/login
管理員退出登錄 API	POST	/api/v1/administrators/actions/logout
修改管理員密碼 API	POST	/api/v1/administrators/actions/resetPassword

操作	請求	地址
新增用戶 API	POST	/api/v1/users
修改用戶 API	PUT	/api/v1/users/{id}
刪除用戶 API	DELETE	/api/v1/users/{id}
獲取用戶 API	GET	/api/v1/users/{id}
獲取用戶頭像 API	GET	/api/v1/users/{id}/avatar
上傳用戶頭像 API	POST	/api/v1/users/{id}/avatar
獲取用戶列表 API	GET	/api/v1/users
用戶登錄 API	POST	/api/v1/users/actions/login
用戶退出登錄 API	POST	/api/v1/users/actions/logout
修改用戶密碼 API	POST	/api/v1/users/actions/resetPassword
新增用戶操作日志 API	POST	/api/v1/users/{id}/logs
獲取用戶操作日志 API	GET	/api/v1/users/{id}/logs

操作	請求	地址
獲取驗證碼圖片 API	GET	/api/v1/captcha/{name}
驗證驗證碼 API	POST	/api/v1/captcha/{name}/actions/check
Ping 可用性 API	GET	/api/v1/ping