นักพัฒนา

X.gd Developers

เราจัดเตรียม API สำหรับย่อ URL จากแอปพลิเคชันภายนอก จำเป็นต้องมี API key เพื่อใช้ API

API ย่อ URL

Shorten API v1.0

GET https://xgd.io/V1/shorten

คำขอ

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL ที่จะย่อ	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	URL สั้นที่กำหนดเอง กำหนดแบบสุ่มหากละไว้	example
	analytics	String	true / false	เปิดใช้งานการวิเคราะห์การเข้าถึง เปิดใช้งานหากละไว้	true
	filterbots	String	true / false	กรองบอทเมื่อเปิดใช้งานการวิเคราะห์ ปิดใช้งานหากละไว้	false
*	key	String	[0-9a-f]{32}	API key ที่ออกให้	0af50e06255c7004f9ad71338f5ad56e

ตัวอย่างคำขอ (URL)

https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}

ตัวอย่างคำขอ (cURL)

curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'

การตอบกลับ (สำเร็จ)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	รหัสสถานะ	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	URL ที่ย่อแล้ว	https://x.gd/example
*	analytics	Boolean	true / false	การวิเคราะห์การเข้าถึง	true
*	filterbots	Boolean	true / false	การกรองบอท	false
*	originalurl	String	http(s)://	URL ต้นฉบับ	https://example.com

ตัวอย่างการตอบกลับ

status: 200
content-type: application/json

{
    "status": 200,
    "shorturl": "https://x.gd/example",
    "analytics": true,
    "filterbots": false,
    "originalurl": "https://example.com/"
}

การตอบกลับ (ล้มเหลว)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	รหัสสถานะ	429
*	message	String	-	ข้อความข้อผิดพลาด	Too many requests.

ตัวอย่างการตอบกลับ

status: 200
content-type: application/json

{
    "status": 429,
    "message": "Too many requests."
}

รหัสสถานะ

Status	Description
200	การตอบกลับปกติ
400	เกิดข้อผิดพลาดในคำขอ ข้อความมีรายละเอียด
401	Token ไม่ถูกต้อง กรุณาตรวจสอบ API key ของคุณ
403	ไม่สามารถใช้งานได้ชั่วคราวหรือถาวร
409	ไม่สามารถออก URL ที่ย่อแล้วภายใต้เงื่อนไขที่ร้องขอ ข้อความมีรายละเอียด
429	ถึงขอบเขตการใช้งาน API แล้ว รอจนกว่าขอบเขตจะถูกปล่อยและลองเรียกอีกครั้ง
500	เกิดข้อผิดพลาดของระบบชั่วคราว ลองเรียกอีกครั้งหลังจากช่วงเวลาหนึ่ง
503	บริการไม่สามารถใช้งานได้ชั่วคราว ลองเรียกอีกครั้งหลังจากช่วงเวลาหนึ่ง

คีย์ API

เราจะส่ง URL สำหรับออก API key ไปยังที่อยู่อีเมลที่คุณให้มา
คุณต้องดำเนินการให้เสร็จภายใน 24 ชั่วโมงหลังจากส่ง