跳轉到

新手上路

注意事項

  • API 只接受 UTF-8 編碼的內容,你必須自行處理編碼問題。
  • 商業使用請參見商業使用
  • 若您發布的成品仍然依賴於繁化姬的 API 服務, 您必須在程式中明確地寫出「本程式使用了繁化姬的 API 服務」讓使用者知曉, 並且於程式中附上繁化姬網頁的「超連結(hyperlink)」。

API 進入點

協定 網址
HTTP http://api.zhconvert.org
HTTPS https://api.zhconvert.org

通用的 API 參數

提示

以下的參數可以在所有的 API 端點上使用。

屬性 說明 型別 預設值
apiKey API 金鑰。目前沒有作用,但也許未來的某天會用到。 string ""
outputFormat 回傳資料的格式。可以是 jsonyamlphp string "json"
prettify 格式化 API 回傳的 JSON 字串以利閱讀。 bool false

API 回應的標準結構

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "code": 0,
    "data": { ... },
    "msg": "",
    "revisions": {
        "build": "dict-fc73e287-r505",
        "msg": "例行性修正字詞 20180127",
        "time": 1517001761
    },
    "execTime": 0.012016
}
屬性 說明 型別
code 錯誤碼,非 0 時表示有錯誤發生以致任務無法進行。錯誤訊息請查看 msg 欄位。 int
data 任務完成後的結果將存放於此,內容視 API 端點而定。 object
msg 警告訊息或是錯誤訊息。 string
revisions.build 繁化姬當下的版本號。 string
revisions.msg 繁化姬當下的版本的更新訊息。 string
revisions.time 繁化姬當下的版本的 UNIX 時間戳(單位為秒)。 int
execTime 此次任務的耗時(單位為秒)。 float

留言板