Deweloperzy

X.gd Developers

Udostępniamy API do skracania URL z zewnętrznych aplikacji. Do korzystania z API wymagany jest klucz API.

API skracania URL

Shorten API v1.0

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

Żądanie

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL do skrócenia	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Niestandardowy krótki URL. Losowe przypisanie, jeśli pominięto	example
	analytics	String	true / false	Włącz analitykę dostępu. Włączone, jeśli pominięto	true
	filterbots	String	true / false	Filtrowanie botów, gdy analityka jest włączona. Wyłączone, jeśli pominięto	false
*	key	String	[0-9a-f]{32}	Wydany klucz API	0af50e06255c7004f9ad71338f5ad56e

Przykład żądania (URL)

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

Przykład żądania (cURL)

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

Odpowiedź (Sukces)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Kod statusu	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Skrócony URL	https://x.gd/example
*	analytics	Boolean	true / false	Analityka dostępu	true
*	filterbots	Boolean	true / false	Filtrowanie botów	false
*	originalurl	String	http(s)://	Oryginalny URL	https://example.com

Przykład odpowiedzi

status: 200
content-type: application/json

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

Odpowiedź (Niepowodzenie)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Kod statusu	429
*	message	String	-	Komunikat o błędzie	Too many requests.

Przykład odpowiedzi

status: 200
content-type: application/json

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

Kod statusu

Status	Description
200	Odpowiedź jest normalna.
400	W żądaniu wystąpił błąd. Komunikat zawiera szczegóły.
401	Token jest nieprawidłowy. Sprawdź swój klucz API.
403	Tymczasowo lub trwale niedostępne.
409	Nie można wydać skróconego URL przy żądanych warunkach. Komunikat zawiera szczegóły.
429	Osiągnięto limit użycia API. Poczekaj, aż limit zostanie zwolniony i spróbuj ponownie wywołać.
500	Tymczasowo wystąpił błąd systemowy. Spróbuj ponownie wywołać po pewnym czasie.
503	Usługa jest tymczasowo niedostępna. Spróbuj ponownie wywołać po pewnym czasie.

Klucz API

Wyślemy URL do wydania klucza API na adres e-mail, który podałeś.
Musisz zakończyć procedurę w ciągu 24 godzin od wysłania.