Kehittäjät

X.gd Developers

Tarjoamme API:n URL-lyhennykseen ulkoisista sovelluksista. API-avain vaaditaan API:n käyttöön.

URL-lyhennys-API

Shorten API v1.0

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

Pyyntö

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	Lyhennettävä URL	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Mukautettu lyhyt URL. Satunnainen määritys, jos jätetään pois	example
	analytics	String	true / false	Ota käyttöön käyttöanalytiikka. Käytössä, jos jätetään pois	true
	filterbots	String	true / false	Bottien suodatus kun analytiikka on käytössä. Pois käytöstä, jos jätetään pois	false
*	key	String	[0-9a-f]{32}	Myönnetty API-avain	0af50e06255c7004f9ad71338f5ad56e

Pyyntöesimerkki (URL)

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

Pyyntöesimerkki (cURL)

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

Vastaus (Onnistui)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Tilakoodi	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Lyhennetty URL	https://x.gd/example
*	analytics	Boolean	true / false	Käyttöanalytiikka	true
*	filterbots	Boolean	true / false	Bottien suodatus	false
*	originalurl	String	http(s)://	Alkuperäinen URL	https://example.com

Vastausesimerkki

status: 200
content-type: application/json

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

Vastaus (Epäonnistui)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Tilakoodi	429
*	message	String	-	Virheviesti	Too many requests.

Vastausesimerkki

status: 200
content-type: application/json

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

Tilakoodi

Status	Description
200	Vastaus on normaali.
400	Pyynnössä tapahtui virhe. Viesti sisältää yksityiskohdat.
401	Merkki on virheellinen. Tarkista API-avaimesi.
403	Tilapäisesti tai pysyvästi ei saatavilla.
409	Lyhennettyä URL:ää ei voi myöntää pyydetyillä ehdoilla. Viesti sisältää yksityiskohdat.
429	API:n käyttöraja saavutettu. Odota, kunnes raja on vapautettu, ja yritä kutsua uudelleen.
500	Järjestelmävirhe on tapahtunut tilapäisesti. Yritä kutsua uudelleen tietyn ajan kuluttua.
503	Palvelu ei ole tilapäisesti käytettävissä. Yritä kutsua uudelleen tietyn ajan kuluttua.

API-avain

Lähetämme URL:n API-avaimen myöntämiseen antamaasi sähköpostiosoitteeseen.
Sinun on suoritettava menettely 24 tunnin kuluessa lähettämisestä.