X.gd Developers
Vi tilbyr en API for å forkorte URL-er fra eksterne applikasjoner. En API-nøkkel kreves for å bruke API-et.
URL-forkortings-API
Shorten API v1.0
GET https://xgd.io/V1/shorten
Forespørsel
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | url | String | http(s):// | URL som skal forkortes | https://example.com |
| shortid | String | [0-9a-zA-Z_]{6,15} | Tilpasset kort URL. Tilfeldig tildeling hvis utelatt | example | |
| analytics | String | true / false | Aktiver tilgangsanalyse. Aktivert hvis utelatt | true | |
| filterbots | String | true / false | Bot-filtrering når analyse er aktivert. Deaktivert hvis utelatt | false | |
| * | key | String | [0-9a-f]{32} | Utstedt API-nøkkel | 0af50e06255c7004f9ad71338f5ad56e |
Forespørselseksempel (URL)
https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}Forespørselseksempel (cURL)
curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'Svar (Suksess)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 200 | Statuskode | 200 |
| * | shorturl | String | https://x.gd/[0-9a-zA-Z_]+ | Forkortet URL | https://x.gd/example |
| * | analytics | Boolean | true / false | Tilgangsanalyse | true |
| * | filterbots | Boolean | true / false | Bot-filtrering | false |
| * | originalurl | String | http(s):// | Opprinnelig URL | https://example.com |
Svareksempel
status: 200
content-type: application/json
{
"status": 200,
"shorturl": "https://x.gd/example",
"analytics": true,
"filterbots": false,
"originalurl": "https://example.com/"
}Svar (Feil)
| * | Parameter | Type | Format | Description | Example |
|---|---|---|---|---|---|
| * | status | Number | 400 / 401 / 403 / 409 / 429 / 500 / 503 | Statuskode | 429 |
| * | message | String | - | Feilmelding | Too many requests. |
Svareksempel
status: 200
content-type: application/json
{
"status": 429,
"message": "Too many requests."
}Statuskode
| Status | Description |
|---|---|
| 200 | Svaret er normalt. |
| 400 | Det oppsto en feil i forespørselen. Meldingen inneholder detaljer. |
| 401 | Tokenet er ikke gyldig. Sjekk API-nøkkelen din. |
| 403 | Midlertidig eller permanent utilgjengelig. |
| 409 | Kan ikke utstede forkortet URL under de forespurte betingelsene. Meldingen inneholder detaljer. |
| 429 | API-bruksgrense nådd. Vent til grensen er opphevet og prøv igjen. |
| 500 | Det oppsto en midlertidig systemfeil. Prøv igjen etter en stund. |
| 503 | Tjenesten er midlertidig utilgjengelig. Prøv igjen etter en stund. |
API-nøkkel
Vi sender en URL for å utstede en API-nøkkel til e-postadressen du oppga.
Du må fullføre prosedyren innen 24 timer etter innsending.