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
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | url | String | http(s):// | Zu verkürzende URL | https://example.com |
| shortid | String | [0-9a-zA-Z_]{6,15} | Benutzerdefinierte kurze URL. Zufällige Zuweisung, wenn weggelassen | example | |
| analytics | String | true / false | Zugriffsanalyse aktivieren. Aktiviert, wenn weggelassen | true | |
| filterbots | String | true / false | Bot-Filterung, wenn Analyse aktiviert ist. Deaktiviert, wenn weggelassen | false | |
| * | key | String | [0-9a-f]{32} | Ausgegebener API-Schlüssel | 0af50e06255c7004f9ad71338f5ad56e |
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)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 200 | Statuscode | 200 |
| * | shorturl | String | https://x.gd/[0-9a-zA-Z_]+ | Verkürzte URL | https://x.gd/example |
| * | analytics | Boolean | true / false | Zugriffsanalyse | true |
| * | filterbots | Boolean | true / false | Bot-Filterung | false |
| * | originalurl | String | http(s):// | Original-URL | https://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)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 400 / 401 / 403 / 409 / 429 / 500 / 503 | Statuscode | 429 |
| * | message | String | - | Fehlermeldung | Too many requests. |
Antwort-Beispiel
status: 200
content-type: application/json
{
"status": 429,
"message": "Too many requests."
}Statuscode
| Status | Description |
|---|---|
| 200 | Die Antwort ist normal. |
| 400 | Bei der Anfrage ist ein Fehler aufgetreten. Die Nachricht enthält Details. |
| 401 | Das Token ist nicht gültig. Überprüfen Sie Ihren API-Schlüssel. |
| 403 | Vorübergehend oder dauerhaft nicht verfügbar. |
| 409 | Verkürzte URL kann unter den angeforderten Bedingungen nicht ausgegeben werden. Die Nachricht enthält Details. |
| 429 | API-Nutzungslimit erreicht. Warten Sie, bis das Limit aufgehoben ist, und versuchen Sie es erneut. |
| 500 | Ein vorübergehender Systemfehler ist aufgetreten. Versuchen Sie es nach einiger Zeit erneut. |
| 503 | Der 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.