Gozi.to

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.