Zagl لوگو

API دستاویزات

اپنے کوڈ سے سیدھا لنکس چھوٹے کریں۔ ایک اینڈ پوائنٹ، ایک بیئرر ٹوکن۔

اینڈ پوائنٹ

POSThttps://za.gl/api/shorten
RESTJSON باڈیبیئرر تصدیق

تصدیق

اپنا API ٹوکن بیئرر ٹوکن کے طور پر اس ہیڈر میں بھیجیں: Authorization پہلا لنک بنانے کے بعد یہ آپ کو اپنے اکاؤنٹ ڈیش بورڈ میں مل جائے گا۔

ہیڈر
Authorization: Bearer YOUR_API_TOKEN

ابھی ٹوکن نہیں ہے؟ آپ اس کے بغیر بھی اینڈ پوائنٹ کال کر سکتے ہیں۔ Za.gl فوراً ایک گمنام اکاؤنٹ بناتا ہے اور نیا ٹوکن یہاں واپس بھیجتا ہے: data.newAuthToken. بعد میں اپنے لنکس سنبھالنے کے لیے اسے محفوظ کر لیں۔

ریکویسٹ باڈی

originalUrlلازمی

string

وہ لمبا URL جسے چھوٹا کرنا ہے۔ پروٹوکول نہ لکھیں تو https:// خود لگ جاتا ہے۔

customAlias

string

آپ کا اپنا اختتام، مثلاً za.gl/my-link۔ منفرد ہونا ضروری ہے، ورنہ 409 ملے گا۔

password

string

لنک کو محفوظ کریں تاکہ آگے بڑھنے کے لیے وزیٹرز کو پاس ورڈ درکار ہو۔

expiresAt

string (ISO date)

لنک کب کام کرنا بند کرے۔ تاریخ مستقبل کی ہونی چاہیے۔

expiresInMinutes / expiresInHours / expiresInDays

number

expiresAt کا متبادل، ایک مقررہ مدت کے بعد میعاد ختم کریں۔

waitTimer

number (0-300)

ری ڈائریکٹ سے پہلے وزیٹر پیش نظارہ صفحے پر کتنے سیکنڈ رکے۔

customGtmId

string

آپ کا اپنا Google Tag Manager ID (GTM-XXXXXXX) جو پیش نظارہ صفحے پر چلتا ہے۔

title / description

string

اختیاری میٹا ڈیٹا جو لنک کے ساتھ محفوظ رہتا ہے۔

generateQR

boolean

شارٹ URL کے لیے QR کوڈ بھی واپس بھیجیں۔

نمونہ ریکویسٹ

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
  }'

نمونہ ریسپانس

کامیاب کال واپس دیتی ہے 200 OK ، جس میں شارٹ URL یہاں ہوتا ہے: 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"
  }
}

ریٹ لمٹس اور خرابیاں

10 req/minفی کلائنٹ زیادہ سے زیادہ 10 ریکویسٹ فی منٹ۔
409یہ کسٹم ایلیاس پہلے سے لیا جا چکا ہے۔
400غلط URL یا گزری ہوئی میعاد کی تاریخ۔
429آپ ریٹ لمٹ یا اپنے ماہانہ کوٹے تک پہنچ گئے۔