Skip to main content
This document will introduce a Short URL API integration guide that can convert long URLs into short URLs.

​
Application Process

To use the API, you need to first apply for the corresponding service on the Short URL API page. After entering the page, click the “Acquire” button, as shown in the image: If you are not logged in or registered, you will be automatically redirected to the login page inviting you to register and log in. After logging in or registering, you will be automatically returned to the current page. There will be a free quota granted upon your first application, allowing you to use the API for free.

​
Basic Usage

First, understand the basic usage method, which is to input the long URL that needs to be converted to obtain the processed result. You need to simply pass a content field. We can then fill in the corresponding content on the interface, as shown in the image:

Here, we have set the Request Headers, including:
  • accept: the format of the response result you want to receive, filled in as application/json, which means JSON format.
  • authorization: the key to call the API, which can be selected directly after application.
Additionally, we set the Request Body, including:
  • content: the content of the URL to be shortened.
After selection, you can see that the corresponding code is also generated on the right side, as shown in the image:

Click the “Try” button to test, as shown in the above image, and we get the following result: 
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
The returned result contains multiple fields, described as follows:
  • success, the status of whether the task was successful.
  • data, which contains the converted URL.
It can be seen that the original long URL https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 has been successfully converted to the short URL https://surl.id/1uHCs01xa5. Additionally, if you want to generate the corresponding integration code, you can directly copy it, for example, the CURL code is as follows: 
curl -X POST 'https://api.acedata.cloud/shorturl' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}'
The Python integration code is as follows: 
import requests

url = "https://api.acedata.cloud/shorturl"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Error Handling

When calling the API, if an error occurs, the API will return the corresponding error code and message. For example:
  • 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.

​
Error Response Example

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusion

Through this document, you have learned how to use the Short URL API to convert long URLs into short URLs. We hope this document helps you better integrate and use the API. If you have any questions, please feel free to contact our technical support team.