罕用字API 介紹

罕用字查詢API是以透過各縣市提供的罕用字型檔來取得字體,再運用程式繪圖的方式將文字產製成圖形檔案,服務引用端確認要查詢的罕用字屬於哪個縣市行政區,再搭配取得的文字編碼既可取得該罕用字的圖形檔案,另引用端在操作API的過程均會紀錄所有引用的過程,以提供罕用字查詢網站進行統計。
Responsive image

罕用字API 介面說明

罕用字查詢API採用Restful風格設計介面,提供GET及POST兩種方式。

GET

HTTP要求
GET http://rarewords.land.moi.gov.tw/api/GetImage
參數
參數名稱 說明
City 縣市代碼
Code 文字編碼
Size 字體大小
Format 圖檔格式
ForeGroundColor 字體顏色
BackGroundColor 背景顏色
BackGroundAlpha 背景是否透明
Encoding 編碼格式(Big5或Unicode)
回應
如果成功,這個方法會回傳指定的圖片內容。
使用範例
http://RareWords.land.moi.gov.tw/api/GetImage?City=B&Code=FA40&Size=90&Format=jpg&ForeGroundColor=000000&BackGroundColor=ffffff&BackGroundAlpha=false&Encoding=BIG5
執行結果

POST

HTTP要求
POST http://rarewords.land.moi.gov.tw/api/ GetImage
參數
參數名稱 說明
City 縣市代碼
Code 文字編碼
Size 字體大小
Format 圖檔格式
ForeGroundColor 字體顏色
BackGroundColor 背景顏色
BackGroundAlpha 背景是否透明
Encoding 編碼格式(Big5或Unicode)
要求內文
依據上述的參數,以JSON格式進行發送。
回應
如果成功,這個方法會回傳指定的圖片內容。
使用範例
POST http://RareWords.land.moi.gov.tw/api/GetImage
	{
        "City" : "B",
"Code" : "FA40",
"Size" : "90",
"Format" : "jpg",
"BackGroundColor" : "ffffff",
"BackGroundAlpha" : "false",
"Encoding" : "BIG5" }
執行結果

罕用字API 範例程式

為了協助開發者順利上手使用本API,提供以下範例程式供開發者自由取用。本程式使用的開發工具如下: