X.gd Developers
Chúng tôi cung cấp API để rút gọn URL từ các ứng dụng bên ngoài. Khóa API được yêu cầu để sử dụng API.
API rút gọn URL
Shorten API v1.0
GET https://xgd.io/V1/shorten
Yêu cầu
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | url | String | http(s):// | URL cần rút gọn | https://example.com |
| shortid | String | [0-9a-zA-Z_]{6,15} | URL ngắn tùy chỉnh. Gán ngẫu nhiên nếu bỏ qua | example | |
| analytics | String | true / false | Kích hoạt truy cập phân tích. Được kích hoạt nếu bỏ qua | true | |
| filterbots | String | true / false | Lọc bot khi phân tích được kích hoạt. Tắt nếu bỏ qua | false | |
| * | key | String | [0-9a-f]{32} | Khóa API đã cấp | 0af50e06255c7004f9ad71338f5ad56e |
Ví dụ yêu cầu (URL)
https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}Ví dụ yêu cầu (cURL)
curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'Phản hồi (Thành công)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 200 | Mã trạng thái | 200 |
| * | shorturl | String | https://x.gd/[0-9a-zA-Z_]+ | URL đã rút gọn | https://x.gd/example |
| * | analytics | Boolean | true / false | Truy cập phân tích | true |
| * | filterbots | Boolean | true / false | Lọc bot | false |
| * | originalurl | String | http(s):// | URL gốc | https://example.com |
Ví dụ phản hồi
status: 200
content-type: application/json
{
"status": 200,
"shorturl": "https://x.gd/example",
"analytics": true,
"filterbots": false,
"originalurl": "https://example.com/"
}Phản hồi (Thất bại)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 400 / 401 / 403 / 409 / 429 / 500 / 503 | Mã trạng thái | 429 |
| * | message | String | - | Thông báo lỗi | Too many requests. |
Ví dụ phản hồi
status: 200
content-type: application/json
{
"status": 429,
"message": "Too many requests."
}Mã trạng thái
| Status | Description |
|---|---|
| 200 | Phản hồi bình thường. |
| 400 | Đã xảy ra lỗi trong yêu cầu. Thông báo chứa chi tiết. |
| 401 | Token không hợp lệ. Kiểm tra khóa API của bạn. |
| 403 | Tạm thời hoặc vĩnh viễn không khả dụng. |
| 409 | Không thể cấp URL ngắn trong các điều kiện được yêu cầu. Thông báo chứa chi tiết. |
| 429 | Bạn đã đạt giới hạn sử dụng API. Đợi cho đến khi giới hạn được dỡ bỏ và thử gọi lại. |
| 500 | Đã xảy ra lỗi hệ thống tạm thời. Thử gọi lại sau một lúc. |
| 503 | Dịch vụ tạm thời không khả dụng. Thử gọi lại sau một lúc. |
Khóa API
Chúng tôi sẽ gửi URL cấp khóa API đến địa chỉ email bạn nhập.
Bạn phải hoàn thành quy trình trong vòng 24 giờ sau khi gửi.