개발자 | X.gd

X.gd Developers

외부 애플리케이션에서 URL 단축 기능을 이용하기 위한 API를 제공합니다. API 이용을 위해서는 API 키 발급이 필요합니다.

URL 단축 API

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 키	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	토큰이 유효하지 않습니다. API 키를 확인해 주세요.
403	일시적 또는 영구적으로 이용할 수 없습니다.
409	요청한 조건으로 단축 URL을 발급할 수 없습니다. 메시지에 자세한 내용이 포함되어 있습니다.
429	API 사용 제한에 도달했습니다. 제한이 해제될 때까지 기다렸다가 다시 시도하세요.
500	일시적으로 시스템 오류가 발생했습니다. 일정 시간 경과 후 다시 시도하세요.
503	일시적으로 서비스를 이용할 수 없습니다. 일정 시간 경과 후 다시 시도하세요.

API 키 발급

입력하신 이메일 주소로 API 키 발급용 URL을 전송합니다.
전송 후 24시간 이내에 절차를 완료해야 합니다.