/api/v1/linksיצירת לינק קצר
יוצר לינק בסביבת העבודה של המפתח. בלי slug נוצרת סיומת אקראית; עם slug הסיומת נספרת במכסת הסיומות המותאמות. אפשרויות בתשלום (תוקף, סיסמה, הפניה לפי מכשיר או מדינה, בדיקת A/B, קמפיין, דומיין משלכם) נבדקות מול התוכנית, ושדה שלא כלול בה נדחה עם feature_locked.
תפקיד נדרש: חבר צוות
גוף הבקשה
destination_urlstring· חובהלאן הלינק מפנה. בלי https:// אנחנו מוסיפים אותו.slugstring | null· רשותהסיומת שאחרי הלוכסן. אותיות בכל שפה, ספרות, מקף וקו תחתון, 2 עד 60 תווים.domain_idstring | null· רשותדומיין ממותג מאומת של סביבת העבודה. בלי ערך, הלינק נוצר על הדומיין הרגיל.titlestring | null· רשותשם פנימי ללינק, עד 200 תווים.notesstring | null· רשותהערות פנימיות, עד 2,000 תווים.tag_idsstring[]· רשותמזהי תגיות של סביבת העבודה. בעדכון, הרשימה מחליפה את הקיימת.campaign_idstring | null· רשותמזהה קמפיין של סביבת העבודה.utmobject· רשותפרמטרי UTM שמתווספים לכתובת היעד: source, medium, campaign, term, content. מחרוזת ריקה מסירה פרמטר.redirect_status301 | 302 | 307· רשותקוד ההפניה: 301, 302 (ברירת המחדל) או 307.forward_queryboolean· רשותהאם להעביר ליעד את פרמטרי השאילתה שנוספו ללינק הקצר.expires_atdatetime | null· רשותמתי הלינק מפסיק להפנות, ISO 8601.expired_redirect_urlstring | null· רשותלאן להפנות אחרי שהתוקף פג.max_clicksinteger | null· רשותאחרי כמה קליקים הלינק מפסיק להפנות.passwordstring | null· רשותסיסמה שהגולשים מתבקשים להקליד, 6 עד 200 תווים. נשמרת מגובבת ולא חוזרת בתשובות.ios_urlstring | null· רשותיעד למכשירי iOS.android_urlstring | null· רשותיעד למכשירי Android.geo_rulesobject[] | null· רשותיעד לפי מדינה: country בקוד של שתי אותיות (IL, US) ו-url.ab_variantsobject[] | null· רשותעד 5 יעדים מתחלפים עם משקל יחסי (weight בין 1 ל-100) ותווית רשות.og_titlestring | null· רשותכותרת לתצוגה המקדימה ברשתות ובווטסאפ.og_descriptionstring | null· רשותתיאור לתצוגה המקדימה ברשתות ובווטסאפ.
curl -X POST "https://kip.li/api/v1/links" \
-H "Authorization: Bearer $KIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"destination_url": "https://example.co.il/sale",
"slug": "winter-sale",
"title": "Winter sale",
"utm": {
"source": "newsletter",
"medium": "email"
}
}'{
"data": {
"id": "lnk_8m2kq4x7c1v9b3n5",
"short_url": "https://kip.li/winter-sale",
"domain": null,
"domain_id": null,
"slug": "winter-sale",
"destination_url": "https://example.co.il/sale?utm_source=newsletter&utm_medium=email",
"title": "Winter sale",
"notes": null,
"status": "active",
"tags": [
{
"id": "tag_4f7h2k9m3p6r8t1w",
"name": "newsletter",
"color": "blue"
}
],
"campaign_id": null,
"redirect_status": 302,
"forward_query": false,
"expires_at": null,
"expired_redirect_url": null,
"max_clicks": null,
"has_password": false,
"ios_url": null,
"android_url": null,
"geo_rules": [],
"ab_variants": [],
"og_title": null,
"og_description": null,
"clicks": 0,
"scans": 0,
"last_clicked_at": null,
"source": "api",
"archived_at": null,
"created_at": "2026-11-02T08:30:00.000Z",
"updated_at": "2026-11-02T08:30:00.000Z"
}
}שגיאות אפשריות: 400 invalid_json · 415 unsupported_media_type · 422 validation_failed · 403 insufficient_role · 422 invalid_url · 422 blocked_url · 422 url_too_long · 422 invalid_target_url · 422 slug_invalid · 422 slug_too_short · 422 slug_too_long · 422 slug_reserved · 409 slug_taken · 422 password_too_short · 403 feature_locked · 403 custom_slugs_limit_reached · 404 tag_not_found · 404 campaign_not_found · 403 links_limit_reached · 404 domain_not_found · 422 domain_not_verified