X.gd Developers
Παρέχουμε ένα API για συντόμευση URL από εξωτερικές εφαρμογές. Απαιτείται κλειδί API για τη χρήση του API.
API συντόμευσης URL
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 | Φιλτράρισμα bot όταν η αναλυτική είναι ενεργοποιημένη. Απενεργοποιημένο εάν παραληφθεί | 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 | Φιλτράρισμα bot | 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 | Το token είναι άκυρο. Ελέγξτε το κλειδί API σας. |
| 403 | Προσωρινά ή μόνιμα μη διαθέσιμο. |
| 409 | Δεν είναι δυνατή η έκδοση συντόμου URL υπό τις ζητούμενες συνθήκες. Το μήνυμα περιέχει λεπτομέρειες. |
| 429 | Φτάσατε το όριο χρήσης API. Περιμένετε την άρση του ορίου και δοκιμάστε να καλέσετε ξανά. |
| 500 | Προέκυψε προσωρινά σφάλμα συστήματος. Δοκιμάστε να καλέσετε ξανά μετά από λίγο. |
| 503 | Η υπηρεσία είναι προσωρινά μη διαθέσιμη. Δοκιμάστε να καλέσετε ξανά μετά από λίγο. |
Κλειδί API
Θα στείλουμε τη διεύθυνση URL για έκδοση κλειδιού API στη διεύθυνση email που εισάγετε.
Πρέπει να ολοκληρώσετε τη διαδικασία εντός 24 ωρών από την υποβολή.