X.gd Developers

Wir bieten eine API zum Verkürzen von URLs aus externen Anwendungen. Ein API-Schlüssel ist erforderlich, um die API zu verwenden.

URL-Verkürzungs-API

Shorten API v1.0

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

Anfrage

*ParameterTypeFormatDescriptionExample
*urlStringhttp(s)://Zu verkürzende URLhttps://example.com
shortidString[0-9a-zA-Z_]{6,15}Benutzerdefinierte kurze URL. Zufällige Zuweisung, wenn weggelassenexample
analyticsStringtrue / falseZugriffsanalyse aktivieren. Aktiviert, wenn weggelassentrue
filterbotsStringtrue / falseBot-Filterung, wenn Analyse aktiviert ist. Deaktiviert, wenn weggelassenfalse
*keyString[0-9a-f]{32}Ausgegebener API-Schlüssel0af50e06255c7004f9ad71338f5ad56e
Anfrage-Beispiel (URL)
https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}
Anfrage-Beispiel (cURL)
curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'

Antwort (Erfolg)

*ParameterTypeFormatDescriptionExample
*statusNumber200Statuscode200
*shorturlStringhttps://x.gd/[0-9a-zA-Z_]+Verkürzte URLhttps://x.gd/example
*analyticsBooleantrue / falseZugriffsanalysetrue
*filterbotsBooleantrue / falseBot-Filterungfalse
*originalurlStringhttp(s)://Original-URLhttps://example.com
Antwort-Beispiel
status: 200
content-type: application/json

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

Antwort (Fehlgeschlagen)

*ParameterTypeFormatDescriptionExample
*statusNumber400 / 401 / 403 / 409 / 429 / 500 / 503Statuscode429
*messageString-FehlermeldungToo many requests.
Antwort-Beispiel
status: 200
content-type: application/json

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

Statuscode

StatusDescription
200Die Antwort ist normal.
400Bei der Anfrage ist ein Fehler aufgetreten. Die Nachricht enthält Details.
401Das Token ist nicht gültig. Überprüfen Sie Ihren API-Schlüssel.
403Vorübergehend oder dauerhaft nicht verfügbar.
409Verkürzte URL kann unter den angeforderten Bedingungen nicht ausgegeben werden. Die Nachricht enthält Details.
429API-Nutzungslimit erreicht. Warten Sie, bis das Limit aufgehoben ist, und versuchen Sie es erneut.
500Ein vorübergehender Systemfehler ist aufgetreten. Versuchen Sie es nach einiger Zeit erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Versuchen Sie es nach einiger Zeit erneut.

API-Schlüssel

Wir senden eine URL zur Ausgabe eines API-Schlüssels an die von Ihnen angegebene E-Mail-Adresse.
Sie müssen den Vorgang innerhalb von 24 Stunden nach dem Absenden abschließen.