請求與回應範例
透過這些範例快速完成整合與除錯
HTTP 請求範例
POST https://{your-api-domain}/sjccup
標頭:
Authorization: Bearer {YOUR_API_TOKEN}
Content-Type: application/json; charset=UTF-8
Body:
{
"media_id": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"keep_distortion": false,
"keep_ori": true
}典型回應範例
成功回應
當請求有效且影像處理成功時，API 會回傳 code = 0，並在 data.data.mediaId 中提供處理後的 Base64 影像。
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"code": 0,
"data": {
"data": {
"mediaId": "<BASE64_PROCESSED_IMAGE>"
}
},
"message": "Success"
}業務錯誤回應
當上游服務回傳業務錯誤時，API 會回傳 error = "API_ERROR" 且 code 為非 0 的錯誤碼。您可以對照下方錯誤碼表來顯示提示或決定是否重試。
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=UTF-8
{
"error": "API_ERROR",
"code": 1004,
"message": "Image size error. Please ensure the image is less than 5MB and the longest side is less than 4000px."
}API 介紹
使用 RemoveHandwriting.com API，專門用於手寫移除的人工智慧技術變得前所未有的簡單。只需幾行程式碼，您就可以將這項技術引入您的應用程式中。
1
購買方案
購買專用於 API 的方案
2
查收專屬郵件
完成購買後 2 小時內，您會收到一封包含專屬 API 網域與 AppCode 的郵件。
3
使用程式碼範例
使用以下程式碼範例快速入門
4
調整參數
返回參數參考以調整請求
身份驗證
我們透過「專屬 API 網域 + Bearer Token」來驗證每一個請求。購買 API 方案後，我們會以電子郵件寄送您的專屬 API 網域與 Token。出於安全考量，請勿公開或分享您的 API Token。
API 端點
POST https://{your-api-domain}/sjccup
請將 {your-api-domain} 替換為我們在購買後透過電子郵件提供給您的 API 網域。每位開發者都會擁有獨立的網域與 Token。
標頭
Authorization:
Bearer {YOUR_API_TOKEN}
請將 {YOUR_API_TOKEN} 替換為我們透過電子郵件提供給您的 Bearer Token。請妥善保管，切勿提交到公開版本庫。
Content-Type:
application/json; charset=UTF-8
程式碼範例
使用我們的程式碼範例快速入門
#!/usr/bin/env bash
set -euo pipefail
# Domain and token for the image processing proxy
API_DOMAIN="https://{your-api-domain}"
API_PATH="/sjccup"
API_TOKEN="{YOUR_API_TOKEN}"
# Image file passed as first argument (default: testpaper.jpg)
IMAGE_FILE="${1:-testpaper.jpg}"
if [ ! -f "$IMAGE_FILE" ]; then
echo "Image file not found: $IMAGE_FILE" >&2
echo "Usage: $0 path/to/image.jpg" >&2
exit 1
fi
echo "Encoding image to Base64: $IMAGE_FILE"
# Encode image to Base64 and remove newlines (use -i for BSD base64 on macOS)
BASE64_IMAGE=$(base64 -i "$IMAGE_FILE" | tr -d '
')
echo "Building JSON body..."
read -r -d '' JSON_BODY <<EOF || true
{
"media_id": "$BASE64_IMAGE",
"keep_distortion": false,
"keep_ori": true
}
EOF
echo "Calling proxy API..."
curl -X POST "${API_DOMAIN}${API_PATH}" \
-H "Authorization: Bearer ${API_TOKEN}" \
-H "Content-Type: application/json; charset=UTF-8" \
-d "$JSON_BODY" \
-o response.json \
-s -w "\nHTTP status: %{http_code}\n"
echo "Response saved to response.json"請求參數
使用這些參數配置您的 API 請求
| 參數 | 類型 | 描述 |
|---|---|---|
| media_id | string | 影像的 Base64 編碼值，最長邊不超過 4000px；移除前綴 data:image/png;base64 |
| keep_distortion | boolean | false – 自動校正失真，true – 停用校正 |
| keep_ori | boolean | false – 影像將旋轉至正確方向，true – 保留上傳時的方向 |
錯誤代碼
API 回應代碼參考
| 錯誤代碼 | 錯誤訊息 | 描述 |
|---|---|---|
| 0 | success | Success |
| 1000 | body error | Request body error |
| 1001 | param error | Request parameter error |
| 1002 | content type error | Content-Type error |
| 1003 | image not exists | Image file not found |
| 1004 | image size error | Image size error |
| 1005 | image format error | Image format error |
| 1006 | invalid signature | Invalid signature |
| 1007 | body size error | Body size error |
| 1008 | no authorization | Authorization failed |
| 2000 | server unknown error | Server unknown error |
| 2001 | server timeout | Server timeout |
| 2003 | no content recognition | No content recognized |
| 2004 | validate data error | Validation data error |
| 3000 | remote server error | Remote server error |
| 4000 | base server error | Base server error |
API 定價方案
以下方案為 API 專屬
入門版
$99$0.198 / 積分
500 積分
3 個月有效期
- 支援大部分圖片格式
- 文件校正與增強
- 文件手寫內容移除
- 圖片摩爾紋移除
- 處理速度約2秒
最受歡迎
熱門
$349$0.07 / 積分
5,000 積分
6 個月有效期
- 支援大部分圖片格式
- 文件校正與增強
- 文件手寫內容移除
- 圖片摩爾紋移除
- 處理速度約2秒
商業版
$749$0.05 / 積分
15,000 積分
1 年有效期
- 支援大部分圖片格式
- 文件校正與增強
- 文件手寫內容移除
- 圖片摩爾紋移除
- 處理速度約2秒
Exclusive
企業版
$1999$0.04 / 積分
50,000 積分
1 年有效期
- 支援大部分圖片格式
- 文件校正與增強
- 文件手寫內容移除
- 圖片摩爾紋移除
- 處理速度約2秒