內部整合文件
用一個請求,建立可信任的短連結。
API 金鑰由你在伺服器環境變數設定。建立、轉址與分析都使用同一個正式網域。
短網址範例
https://gotw.cc/a7B
從 3 碼開始,該長度的可用組合用完後才增加位數。
驗證方式
API 金鑰由管理員在後台查看,伺服器透過環境變數 API_KEY 載入。這把金鑰只放在後端與呼叫端的私密環境變數,不要寫進瀏覽器程式碼。
API_KEY=你的管理員提供的金鑰
每次呼叫管理 API 時,透過 Bearer Token 傳送:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json
POST
/api/v1/links
建立短網址
只需要提供目的網址。若沒有提供自訂 slug,系統會從 3 碼英數短碼開始;所有可用組合用完後,才增加到 4 碼,依此類推。
curl -X POST 'https://gotw.cc/api/v1/links' \
-H "Authorization: Bearer $API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/campaign"
}'
成功回應
{
"id": "2d052ecb-c44b-4ccd-a288-998f34f08a2c",
"slug": "a7B",
"requested_slug": null,
"slug_adjusted": false,
"short_url": "https://gotw.cc/a7B",
"destination_url": "https://example.com/campaign",
"created_at": "2026-08-13T02:20:30.000Z",
"expires_at": null
}
自訂 Slug 與防重
Slug 路徑區分大小寫。自訂名稱如果已存在,資料庫唯一限制會阻止重複,服務則自動配置下一個可用名稱。
/Launch
已存在時
/Launch-2
{
"url": "https://example.com/launch",
"slug": "Launch"
}
呼叫端應永遠採用回應中的 short_url,不要自行拼接或猜測最後取得的 slug。
GET
/api/v1/links/{slug}/analytics?days=30
讀取點擊分析
回傳總點擊、區間點擊、獨立訪客、重複造訪率,以及每日、國家、來源與裝置分布。
curl 'https://gotw.cc/api/v1/links/a7B/analytics?days=30' \
-H "Authorization: Bearer $API_KEY" \
-H 'Accept: application/json'
period_clicks
指定天數內的點擊總數
unique_visitors
經單向雜湊辨識的訪客數
repeat_visit_rate
重複造訪比例,範圍 0 到 1
CTR 必須另外取得曝光數。短網址服務只有點擊資料,正確公式為 period_clicks / impressions。
錯誤處理
400輸入格式不合法401API 金鑰遺漏或錯誤404找不到指定短網址429超過 API 速率限制503資料服務暫時無法使用{
"error": {
"code": "INVALID_INPUT",
"message": "slug is reserved"
}
}