Zagl logo

API dokumentatsioon

Lühenda linke otse oma koodist. Üks lõpp-punkt, üks bearer-token.

Lõpp-punkt

POSThttps://za.gl/api/shorten
RESTJSON-kehaBearer-autentimine

Autentimine

Saada oma API-token Authorization päises bearer-tokenina. Leiad selle oma konto töölaualt pärast esimese lingi loomist.

Päis
Authorization: Bearer YOUR_API_TOKEN

Tokenit veel pole? Võid lõpp-punkti kutsuda ka ilma. Za.gl loob lennult anonüümse konto ja tagastab uue tokeni väljal data.newAuthToken. Salvesta see, et hiljem oma linke hallata.

Päringu keha

originalUrlkohustuslik

string

Pikk URL, mida lühendada. Kui protokoll puudub, lisame https:// ise.

customAlias

string

Sinu enda lõpuosa, nt za.gl/my-link. Peab olema unikaalne, muidu saad vastuseks 409.

password

string

Kaitse link nii, et külastaja peab jätkamiseks parooli sisestama.

expiresAt

string (ISO date)

Millal link lakkab töötamast. Peab olema tulevikus.

expiresInMinutes / expiresInHours / expiresInDays

number

Alternatiiv väljale expiresAt, aegub teatud aja möödudes.

waitTimer

number (0-300)

Sekundid, mis külastaja ootab eelvaatelehel enne ümbersuunamist.

customGtmId

string

Sinu enda Google Tag Manageri ID (GTM-XXXXXXX), mis käivitub eelvaatelehel.

title / description

string

Valikulised metaandmed, mis salvestatakse lingi juurde.

generateQR

boolean

Tagasta lühilingi jaoks ka QR-kood.

Näidispäring

POSTcURL
curl -X POST https://za.gl/api/shorten \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "password": "optional-secret",
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "waitTimer": 5
  }'

Näidisvastus

Õnnestunud päring tagastab 200 OK ja lühilink on väljal data.shortUrl.

200 OKJSON
{
  "success": true,
  "message": "URL shortened successfully",
  "data": {
    "id": "123",
    "alias": "my-link",
    "shortUrl": "https://za.gl/my-link",
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "domain": "za.gl",
    "title": "",
    "description": null,
    "hasPassword": true,
    "isActive": true,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "hits": 0,
    "waitTimer": 5,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:00.000Z",
    "authToken": "your-account-token"
  }
}

Päringupiirangud ja vead

10 req/minKuni 10 päringut minutis kliendi kohta.
409See alias on juba võetud.
400Vigane URL või minevikus olev aegumiskuupäev.
429Ületasid päringupiirangu või kuu limiidi.