API

स्क्रिप्ट और ऐप से छोटे लिंक बनाएँ और प्रबंधित करें। API मुफ़्त है। अपने डैशबोर्ड में API कुंजियाँ के नीचे एक कुंजी बनाएँ, फिर उसे bearer टोकन के रूप में भेजें।

प्रमाणीकरण

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 पर है।