API

اسکرپٹس اور ایپس سے مختصر لنکس بنائیں اور سنبھالیں۔ API مفت ہے۔ اپنے ڈیش بورڈ میں API کلیدیں کے تحت ایک کلید بنائیں، پھر اسے bearer token کے طور پر بھیجیں۔

تصدیق

Authorization: Bearer gz_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

کلیدیں صرف ایک بار دکھائی جاتی ہیں۔ انہیں پاس ورڈ کی طرح سنبھالیں: جس کے پاس آپ کی کلید ہو وہ آپ کے اکاؤنٹ میں لنکس بنا اور بدل سکتا ہے۔ لیک ہونے والی کلید ڈیش بورڈ سے منسوخ کر دیں۔

حدود

لنک بنائیں

curl -X POST https://gozi.to/api/my/links \
  -H "Authorization: Bearer $GOZI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/launch", "code": "launch"}'

code اختیاری ہے (4–32 حروف، اعداد، - یا _)۔ بے ترتیب 7 حرفی کوڈ کے لیے اسے چھوڑ دیں۔ جواب 201:

{
  "link": {
    "code": "launch",
    "shortUrl": "https://gozi.to/launch",
    "url": "https://example.com/launch",
    "status": "active",
    "statusReason": null,
    "custom": true,
    "createdAt": 1790000000000,
    "expiresAt": null
  }
}

لنکس کی فہرست

GET /api/my/links?limit=25&cursor=<nextCursor>&q=<search>&clicks=1

نئے پہلے۔ اگلا صفحہ لینے کے لیے پچھلے صفحے کا nextCursor بھیجیں۔ clicks=1 ہر وقت کے انسانی کلکس کی گنتی شامل کر دیتا ہے۔

حاصل کریں، ترمیم کریں، حذف کریں

GET    /api/my/links/{code}
PATCH  /api/my/links/{code}   {"url": "https://new.example"}  or  {"status": "disabled" | "active"}
DELETE /api/my/links/{code}

تجزیات

GET /api/my/links/{code}/stats

پچھلے 90 دن اور ہر وقت کے انسانی کلکس، روزانہ کلکس، اور سرِفہرست ممالک، حوالہ دہندگان، ڈیوائسز، براؤزرز اور آپریٹنگ سسٹم واپس کرتا ہے۔ بوٹس اور لنک پیش نظارے (Slack، WhatsApp، وغیرہ) الگ سے botClicks میں گنے جاتے ہیں۔ نتائج تقریباً 5 منٹ کے لیے کیش رہتے ہیں۔

خرابیاں

خرابیاں HTTP سٹیٹس کوڈز اور ایک JSON باڈی استعمال کرتی ہیں:

{ "error": { "code": "slug_taken", "message": "That custom link is already taken." } }

ہر اینڈ پوائنٹ کی مشین کے پڑھنے لائق تفصیل /openapi.json پر موجود ہے۔