開発者向け | 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時間以内に手続きを完了させる必要があります。