跳轉到主要內容
本文將介紹一種 Short URL API 對接說明,它可將較長的URL轉換為短的URL。

申請流程

要使用 Short URL API,首先到 Ace Data Cloud 控制台 獲取您的 API Token,留作備用。 如果你尚未登入或註冊,會自動跳轉到登入頁面邀請你註冊和登入,完成後會自動返回當前頁面。 一個 API Token 即可調用平台所有服務,無需為每個服務單獨申請。 首次申請會贈送免費額度,可免費體驗;額度不足時可在 控制台 充值通用餘額。
📘 完整文檔:Short URL API →

基本使用

首先先了解下基本的使用方式,就是輸入需要轉換的較長URL,便可獲得處理後的結果,首先需要簡單地傳遞一個 content 字段。我們接下來就可以在介面上填寫對應的內容,如圖所示:

可以看到這裡我們設定了 Request Headers,包括:
  • accept:想要接收怎樣格式的響應結果,這裡填寫為 application/json,即 JSON 格式。
  • authorization:調用 API 的密鑰,申請之後可以直接下拉選擇。
另外設定了 Request Body,包括:
  • content:要縮短的URL的內容。
選擇之後,可以發現右側也生成了對應代碼,如圖所示:

點擊「Try」按鈕即可進行測試,如上圖所示,這裡我們就得到了如下結果:
返回結果一共有多個字段,介紹如下:
  • success,此處任務是否成功的狀態。
  • data,包含了此處轉換後的URL。
可以看出 原先較長的URL https://platform.acedata.cloud/documents/shorturl 已經成功轉換為短的URL https://surl.id/1uHCs01xa5。 另外如果想生成對應的對接代碼,可以直接複製生成,例如 CURL 的代碼如下:
Python 的對接代碼如下:

錯誤處理

在調用 API 時,如果遇到錯誤,API 會返回相應的錯誤代碼和信息。例如:
  • 400 token_mismatched:Bad request, possibly due to missing or invalid parameters.
  • 400 api_not_implemented:Bad request, possibly due to missing or invalid parameters.
  • 401 invalid_token:Unauthorized, invalid or missing authorization token.
  • 429 too_many_requests:Too many requests, you have exceeded the rate limit.
  • 500 api_error:Internal server error, something went wrong on the server.

錯誤響應示例

結論

通過本文檔,您已經了解了如何使用 Short URL API 將較長的URL轉換為短的URL。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題,請隨時聯繫我們的技術支持團隊。