דלגו לתוכן
kip

ה-API של KIP

קצרו לינקים, משכו נתוני קליקים והורידו קודי QR ישר מהקוד שלכם. אותן יכולות של הדשבורד, באותן מכסות ובאותן הרשאות.

בקשה ראשונה
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"
    }
  }'

מה אפשר לעשות עם ה-API

ה-API מחבר את KIP למערכות שלכם: החנות, ה-CRM, מערכת ההזמנות או סקריפט שרץ בלילה. הוא יוצר לינקים קצרים, עורך אותם, מעביר לארכיון ומוחק, מחזיר נתוני קליקים וסריקות לכל לינק ומפיק קוד QR לכל לינק כקובץ PNG או SVG.

כל בקשה פועלת בתוך סביבת העבודה של המפתח. בדיקות התוכנית, המכסות וההרשאות הן אותן בדיקות שהדשבורד עושה, כך שמה שחסום בדשבורד חסום גם כאן.

הבקשות והתשובות הן JSON בקידוד UTF-8. שמות השדות באנגלית ב-snake_case, וזמנים בפורמט ISO 8601 ב-UTC. עברית עוברת כמו שהיא, גם בסיומות של לינקים.

ה-API נועד לשרת שלכם ולא לדפדפן: הוא לא מאפשר קריאות מאתרים אחרים (אין CORS), כדי שהמפתח לא יגיע לקוד שרץ אצל הגולשים.

כתובת הבסיס
https://kip.li/api/v1

בקשה ראשונה בשלושה צעדים

  1. צרו מפתח

    בדשבורד, בהגדרות ← API. העתיקו את המפתח ושמרו אותו במשתנה סביבה בשם KIP_API_KEY.
  2. קצרו לינק

    שלחו POST עם כתובת היעד. סיומת לבחירתכם היא רשות; בלעדיה נוצרת סיומת אקראית.
  3. קראו את הנתונים

    שלחו את ה-id שחזר אל נקודת הקצה של הנתונים, וקבלו סיכום וסדרת זמן לטווח שבחרתם.
קצרו לינק · curl
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"
    }
  }'
קראו את הנתונים · curl
curl "https://kip.li/api/v1/links/lnk_8m2kq4x7c1v9b3n5/stats?range=7d" \
  -H "Authorization: Bearer $KIP_API_KEY"

מפתחות API

יוצרים מפתח בדשבורד, בהגדרות ← API. רק מנהלים ובעלים של סביבת העבודה יכולים ליצור מפתח או לבטל אותו. לכל מפתח יש שם, כדי שתדעו איזו מערכת משתמשת בו.

המפתח המלא מוצג פעם אחת, ברגע היצירה. אנחנו שומרים רק גיבוב שלו, ולכן אי אפשר לשחזר אותו. שמרו אותו במנהל סודות או במשתנה סביבה, ואל תכניסו אותו למאגר הקוד.

מפתח פועל בהרשאות של מי שיצר אותו. מי שבתפקיד צפייה בלבד יכול לקרוא, ושינויים דורשים לפחות חבר צוות. מי שעוזב את סביבת העבודה לוקח איתו את המפתחות שלו: הם מפסיקים לעבוד.

אם מפתח דלף, בטלו אותו באותו מסך וצרו חדש. מפתח מבוטל נדחה מהבקשה הבאה.

אימות

שלחו את המפתח בכותרת Authorization בכל בקשה, בשיטת Bearer. בלי כותרת, או עם מפתח לא מוכר, התשובה היא 401.

HTTP
Authorization: Bearer kip_live_…

מגבלות

שני גבולות חלים על כל בקשה:

  • קצב: עד 120 בקשות בדקה לכל מפתח. בקשה מעבר לזה מקבלת 429 עם הקוד rate_limited וכותרת Retry-After בשניות.
  • מכסה חודשית: מספר הבקשות בחודש לסביבת עבודה, לפי התוכנית. המכסה מתחדשת ב-1 בכל חודש, לפי שעון ישראל. כל בקשה מאומתת שעברה את בדיקת הקצב נספרת, גם כזו שנכשלה בבדיקת השדות. מעבר למכסה התשובה היא 429 עם הקוד monthly_limit_reached.
מכסות חודשיות לפי תוכנית
תוכניתבקשות API בחודשלינקים בחודשסיומות מותאמות בחודשהיסטוריית נתונים
חינם50025530 ימים
בסיס5,0001505090 ימים
צמיחה25,000600300365 ימים
פרימיום100,0003,0003,000730 ימים
ארגוניללא הגבלהללא הגבלהללא הגבלה1,095 ימים

לינקים שנוצרים דרך ה-API נספרים באותה מכסה חודשית של לינקים וסיומות מותאמות כמו בדשבורד. את המצב הנוכחי מחזירה נקודת הקצה של סביבת העבודה.

כותרות בכל תשובה

כותרות בכל תשובה
כותרתמשמעות
X-RateLimit-Limitכמה בקשות מותרות בדקה למפתח הזה.
X-RateLimit-Remainingכמה בקשות נשארו בדקה הנוכחית.
X-RateLimit-Resetמתי הדקה מתחילה מחדש, בשניות מאז 1970 (Unix time).
X-Request-Idמזהה הבקשה. צרפו אותו כשאתם כותבים לנו על תקלה.

שגיאות

כל שגיאה חוזרת באותו מבנה, עם קוד סטטוס מתאים. code הוא מזהה קבוע באנגלית שאפשר לבנות עליו לוגיקה. message הוא משפט בעברית שאפשר להציג כמו שהוא למשתמשים שלכם.

בשגיאת validation_failed מגיע גם details: רשימה של השדות שנפסלו, וסוג הבעיה בכל אחד.

JSON · 422
{
  "error": {
    "code": "validation_failed",
    "message": "חלק מהשדות לא מולאו כמו שצריך. בדקו את הסימונים ונסו שוב.",
    "details": [
      {
        "field": "destination_url",
        "issue": "invalid_type"
      }
    ]
  }
}
קודי השגיאה
סטטוסקודמתי זה קורה
400invalid_jsonגוף הבקשה הוא לא JSON תקין.
401missing_api_keyלא נשלחה כותרת Authorization עם מפתח.
401invalid_api_keyהמפתח לא מוכר לנו.
401api_key_revokedהמפתח בוטל בהגדרות.
401api_key_expiredתוקף המפתח פג.
401api_key_owner_removedמי שיצר את המפתח כבר לא חבר בסביבת העבודה.
403workspace_disabledסביבת העבודה הושבתה.
403insufficient_roleהתפקיד של יוצר המפתח לא מאפשר את הפעולה, למשל שינוי עם תפקיד צפייה בלבד.
403feature_lockedהפעולה דורשת יכולת שלא כלולה בתוכנית.
403links_limit_reachedנוצרו כל הלינקים של החודש בתוכנית.
403custom_slugs_limit_reachedנוצלו כל הסיומות המותאמות של החודש בתוכנית.
404route_not_foundאין נקודת קצה בכתובת הזו.
404link_not_foundאין לינק עם המזהה הזה בסביבת העבודה.
404tag_not_foundאחת התגיות לא קיימת בסביבת העבודה.
404campaign_not_foundהקמפיין לא קיים בסביבת העבודה.
404domain_not_foundהדומיין לא קיים בסביבת העבודה.
405method_not_allowedשיטת ה-HTTP לא נתמכת בכתובת הזו. הכותרת Allow מפרטת את השיטות הנתמכות.
409slug_takenהסיומת כבר תפוסה בדומיין הזה.
409tag_name_takenכבר יש תגית בשם הזה.
415unsupported_media_typeגוף הבקשה נשלח בלי Content-Type: application/json.
422validation_failedאחד השדות או הפרמטרים לא תקין. הפירוט ב-details.
422invalid_urlכתובת היעד לא תקינה.
422blocked_urlאי אפשר לקצר את כתובת היעד, למשל לינק של שירות קיצור אחר.
422url_too_longכתובת היעד ארוכה מ-4,096 תווים.
422invalid_target_urlכתובת לאפליקציה (iOS או Android) לא תקינה.
422slug_invalidבסיומת יש תווים שאינם אותיות, ספרות, מקף או קו תחתון.
422slug_too_shortהסיומת קצרה מ-2 תווים.
422slug_too_longהסיומת ארוכה מ-60 תווים.
422slug_reservedהסיומת שמורה למערכת.
422domain_not_verifiedהדומיין עדיין לא אומת.
422password_too_shortהסיסמה של הלינק קצרה מ-6 תווים.
422qr_data_too_longהכתובת ארוכה מדי לקוד QR אחד.
429rate_limitedיותר מדי בקשות בדקה מהמפתח הזה.
429monthly_limit_reachedנוצלה מכסת הבקשות החודשית של התוכנית.
500internal_errorתקלה אצלנו. נסו שוב, ואם זה חוזר כתבו לנו עם X-Request-Id.

עימוד

כל רשימה חוזרת עם data ו-pagination. שלחו page (מתחיל ב-1) ו-page_size (עד 100, ברירת המחדל 20). has_more אומר אם יש עמוד נוסף, ו-total הוא מספר הפריטים בכל העמודים יחד.

JSON
{
  "data": [
    "…"
  ],
  "pagination": {
    "page": 2,
    "page_size": 20,
    "total": 57,
    "total_pages": 3,
    "has_more": true
  }
}

כך עוברים על כל הלינקים, עמוד אחרי עמוד:

Node.js
const links = [];
for (let page = 1; ; page++) {
  const res = await fetch(`https://kip.li/api/v1/links?page=${page}&page_size=100`, {
    headers: { Authorization: `Bearer ${process.env.KIP_API_KEY}` },
  });
  const { data, pagination } = await res.json();
  links.push(...data);
  if (!pagination.has_more) break;
}

כל נקודות הקצה

הרשימה הזו נבנית מאותה טבלה שממנה נבנים ה-API עצמו ומסמך ה-OpenAPI, כך שהיא תמיד תואמת את מה שרץ.

נתונים

GET/api/v1/links/{id}/stats

נתוני לינק

סיכום קליקים, סריקות ומבקרים שונים (uniques) לטווח, לצד אותו סיכום לתקופה הקודמת, וסדרת זמן ממולאת באפסים. הזמנים לפי אזור הזמן של סביבת העבודה. טווח שחורג מההיסטוריה של התוכנית מקוצץ, ואז clamped הוא true. כשהתקופה הקודמת חורגת מההיסטוריה של התוכנית, previous_comparable הוא false ו-previous מכיל אפסים שאין להשוות אליהם.

תפקיד נדרש: צפייה בלבד

פרמטרים
  • idstring· חובה
    מזהה הלינק, למשל lnk_8m2kq4x7c1v9b3n5.
  • range24h | 7d | 30d | 90d | 12m | month | custom· רשות
    24h, 7d, 30d, 90d, 12m, month (החודש הנוכחי) או custom עם from ו-to.ברירת מחדל: 30d
  • fromstring· רשות
    היום הראשון בטווח custom, בפורמט YYYY-MM-DD.
  • tostring· רשות
    היום האחרון בטווח custom (כולל), בפורמט YYYY-MM-DD.
בקשה · curl
curl "https://kip.li/api/v1/links/lnk_8m2kq4x7c1v9b3n5/stats?range=7d" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": {
    "link_id": "lnk_8m2kq4x7c1v9b3n5",
    "range": {
      "key": "7d",
      "from": "2026-11-09T22:00:00.000Z",
      "to": "2026-11-16T09:12:00.000Z",
      "timezone": "Asia/Jerusalem",
      "granularity": "day",
      "clamped": false
    },
    "totals": {
      "clicks": 96,
      "scans": 11,
      "total": 107,
      "uniques": 81,
      "previous": {
        "clicks": 70,
        "scans": 9,
        "total": 79,
        "uniques": 63
      },
      "previous_comparable": true
    },
    "timeseries": [
      {
        "bucket": "2026-11-09T22:00:00.000Z",
        "clicks": 12,
        "scans": 1,
        "total": 13
      },
      {
        "bucket": "2026-11-10T22:00:00.000Z",
        "clicks": 18,
        "scans": 2,
        "total": 20
      },
      {
        "bucket": "2026-11-11T22:00:00.000Z",
        "clicks": 9,
        "scans": 0,
        "total": 9
      }
    ]
  }
}

שגיאות אפשריות: 404 link_not_found · 422 validation_failed

GET/api/v1/links/{id}/breakdown

פילוח נתוני לינק

הערכים המובילים של מדד אחד: מדינה, עיר, אזור, מכשיר, מערכת הפעלה, דפדפן, מקור הגעה או שפה. פילוח לפי עיר ואזור דורש תוכנית שכוללת אנליטיקס לפי עיר. ערך שלא נקלט חוזר כ-unknown, והגעה ישירה כ-direct.

תפקיד נדרש: צפייה בלבד

פרמטרים
  • idstring· חובה
    מזהה הלינק, למשל lnk_8m2kq4x7c1v9b3n5.
  • dimensioncountry | city | region | device | os | browser | referrer | language· חובה
    לפי מה לפלח.
  • range24h | 7d | 30d | 90d | 12m | month | custom· רשות
    24h, 7d, 30d, 90d, 12m, month (החודש הנוכחי) או custom עם from ו-to.ברירת מחדל: 30d
  • fromstring· רשות
    היום הראשון בטווח custom, בפורמט YYYY-MM-DD.
  • tostring· רשות
    היום האחרון בטווח custom (כולל), בפורמט YYYY-MM-DD.
  • limitinteger· רשות
    כמה ערכים להחזיר, עד 50.ברירת מחדל: 10
בקשה · curl
curl "https://kip.li/api/v1/links/lnk_8m2kq4x7c1v9b3n5/breakdown?dimension=referrer&range=7d" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": {
    "link_id": "lnk_8m2kq4x7c1v9b3n5",
    "dimension": "referrer",
    "range": {
      "key": "7d",
      "from": "2026-11-09T22:00:00.000Z",
      "to": "2026-11-16T09:12:00.000Z",
      "timezone": "Asia/Jerusalem",
      "granularity": "day",
      "clamped": false
    },
    "items": [
      {
        "key": "instagram.com",
        "count": 41,
        "share": 0.383,
        "country": null
      },
      {
        "key": "whatsapp",
        "count": 33,
        "share": 0.308,
        "country": null
      },
      {
        "key": "direct",
        "count": 21,
        "share": 0.196,
        "country": null
      }
    ]
  }
}

שגיאות אפשריות: 404 link_not_found · 422 validation_failed · 403 feature_locked

תגיות

GET/api/v1/tags

רשימת תגיות

כל התגיות של סביבת העבודה לפי שם, עם מספר הלינקים בכל תגית.

תפקיד נדרש: צפייה בלבד

פרמטרים
  • pageinteger· רשות
    מספר העמוד, מתחיל ב-1.ברירת מחדל: 1
  • page_sizeinteger· רשות
    כמה פריטים בעמוד, עד 100.ברירת מחדל: 20
בקשה · curl
curl "https://kip.li/api/v1/tags" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": [
    {
      "id": "tag_4f7h2k9m3p6r8t1w",
      "name": "newsletter",
      "color": "blue",
      "link_count": 12,
      "created_at": "2026-11-02T08:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}

שגיאות אפשריות: 422 validation_failed

POST/api/v1/tags

יצירת תגית

אין שתי תגיות באותו שם בסביבת עבודה, גם בהבדל של אותיות גדולות וקטנות בלבד. את ה-id שחוזר שולחים ב-tag_ids של לינק.

תפקיד נדרש: חבר צוות

גוף הבקשה
  • namestring· חובה
    שם התגית, עד 40 תווים.
  • colorblue | purple | teal | amber | rose | green | red | gray· רשות
    צבע התגית: blue, purple, teal, amber, rose, green, red או gray.ברירת מחדל: blue
בקשה · curl
curl -X POST "https://kip.li/api/v1/tags" \
  -H "Authorization: Bearer $KIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "newsletter",
    "color": "blue"
  }'
תשובה · 201
{
  "data": {
    "id": "tag_4f7h2k9m3p6r8t1w",
    "name": "newsletter",
    "color": "blue",
    "link_count": 0,
    "created_at": "2026-11-02T08:30:00.000Z"
  }
}

שגיאות אפשריות: 400 invalid_json · 415 unsupported_media_type · 422 validation_failed · 403 insufficient_role · 409 tag_name_taken

קמפיינים

GET/api/v1/campaigns

רשימת קמפיינים

הקמפיינים של סביבת העבודה, מהחדש לישן, כולל קמפיינים בארכיון. את ה-id שולחים ב-campaign_id של לינק.

תפקיד נדרש: צפייה בלבד

פרמטרים
  • pageinteger· רשות
    מספר העמוד, מתחיל ב-1.ברירת מחדל: 1
  • page_sizeinteger· רשות
    כמה פריטים בעמוד, עד 100.ברירת מחדל: 20
בקשה · curl
curl "https://kip.li/api/v1/campaigns" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": [
    {
      "id": "cmp_2b8n4m6k1q3w5e7r",
      "name": "Hanukkah 2026",
      "description": null,
      "utm_campaign": "hanukkah-2026",
      "starts_at": "2026-12-04T22:00:00.000Z",
      "ends_at": "2026-12-12T22:00:00.000Z",
      "archived": false,
      "link_count": 6,
      "created_at": "2026-11-02T08:30:00.000Z",
      "updated_at": "2026-11-10T12:05:41.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}

שגיאות אפשריות: 422 validation_failed

דומיינים

GET/api/v1/domains

רשימת דומיינים

הדומיינים הממותגים של סביבת העבודה ומצב האימות שלהם. רק דומיין במצב verified יכול לקבל לינקים, דרך domain_id.

תפקיד נדרש: צפייה בלבד

פרמטרים
  • pageinteger· רשות
    מספר העמוד, מתחיל ב-1.ברירת מחדל: 1
  • page_sizeinteger· רשות
    כמה פריטים בעמוד, עד 100.ברירת מחדל: 20
בקשה · curl
curl "https://kip.li/api/v1/domains" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": [
    {
      "id": "dom_7c3v9b1n5m2k4q6x",
      "hostname": "go.example.co.il",
      "status": "verified",
      "verified_at": "2026-11-10T12:05:41.000Z",
      "root_redirect_url": "https://example.co.il",
      "not_found_redirect_url": null,
      "link_count": 31,
      "created_at": "2026-11-02T08:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}

שגיאות אפשריות: 422 validation_failed

סביבת עבודה

GET/api/v1/workspace

סביבת העבודה

סביבת העבודה של המפתח: התוכנית, היכולות שהיא כוללת, המגבלות שלה והשימוש בחודש הנוכחי. null במגבלה פירושו ללא הגבלה.

תפקיד נדרש: צפייה בלבד

בקשה · curl
curl "https://kip.li/api/v1/workspace" \
  -H "Authorization: Bearer $KIP_API_KEY"
תשובה · 200
{
  "data": {
    "id": "ws_5k8m2q4x7c1v9b3n",
    "name": "My workspace",
    "slug": "my-workspace",
    "timezone": "Asia/Jerusalem",
    "plan": {
      "id": "growth",
      "features": [
        "utmBuilder",
        "editDestination",
        "campaigns",
        "customDomains"
      ],
      "limits": {
        "links_per_month": 600,
        "qr_codes_per_month": 30,
        "custom_slugs_per_month": 300,
        "api_requests_per_month": 25000,
        "pages": 10,
        "domains": 1,
        "members": 3,
        "history_days": 365
      }
    },
    "usage": {
      "period": "2026-11",
      "links": {
        "used": 42,
        "limit": 600
      },
      "qr_codes": {
        "used": 3,
        "limit": 30
      },
      "custom_slugs": {
        "used": 17,
        "limit": 300
      },
      "api_requests": {
        "used": 1208,
        "limit": 25000
      }
    },
    "created_at": "2026-11-02T08:30:00.000Z"
  }
}

המסמך עצמו

GET/api/v1/openapi.json

מסמך OpenAPI

תיאור מלא של ה-API בפורמט OpenAPI 3.1. פתוח לכולם, בלי מפתח.

בלי מפתח

בקשה · curl
curl "https://kip.li/api/v1/openapi.json"

Webhooks

Webhook שולח בקשת POST לשרת שלכם כשמשהו קורה בסביבת העבודה, כך שאין צורך לשאול את ה-API שוב ושוב. מגדירים כתובת, בוחרים אירועים ומקבלים סוד חתימה בהגדרות ← Webhooks.

Webhooks כלולים מתוכנית פרימיום.

אירועים

אירועים
אירועמתי נשלח
link.createdנוצר לינק, בדשבורד או דרך ה-API.
link.updatedלינק השתנה, עבר לארכיון או חזר ממנו.
link.deletedלינק נמחק.
qr.createdנוצר קוד QR.
qr.deletedנמחק קוד QR.
page.publishedעמוד לינק-אין-ביו פורסם.

מה מגיע בבקשה

גוף הבקשה הוא JSON עם id של השליחה, event, createdAt ו-data. ב-data נמצא האובייקט שהשתנה, ותמיד יש בו id. באירועי לינקים שנוצרו דרך ה-API, data הוא אובייקט הלינק המלא, זהה למה שה-API מחזיר.

בכותרות מגיעים X-KIP-Event עם שם האירוע ו-X-KIP-Signature עם החתימה.

POST · JSON
{
  "id": "msg_3k9m2q7x4c8v1b6n",
  "event": "link.created",
  "createdAt": "2026-11-16T09:12:44.512Z",
  "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": 128,
    "scans": 14,
    "last_clicked_at": "2026-11-10T12:05:41.000Z",
    "source": "api",
    "archived_at": null,
    "created_at": "2026-11-02T08:30:00.000Z",
    "updated_at": "2026-11-10T12:05:41.000Z"
  }
}

אימות החתימה

החתימה היא HMAC-SHA256 של גוף הבקשה הגולמי, בדיוק כפי שהגיע, עם הסוד של ה-Webhook, בהקסדצימלי ואחרי הקידומת sha256=. חשבו אותה בעצמכם והשוו בהשוואה בזמן קבוע. דחו בקשה שהחתימה שלה לא תואמת.

Node.js · Express
import { createHmac, timingSafeEqual } from "node:crypto";
import express from "express";

function isFromKip(rawBody, signature, secret) {
  const expected = "sha256=" + createHmac("sha256", secret).update(rawBody).digest("hex");
  const a = Buffer.from(expected);
  const b = Buffer.from(signature ?? "");
  return a.length === b.length && timingSafeEqual(a, b);
}

const app = express();

// Keep the raw body: the signature covers the exact bytes we sent.
app.post("/webhooks/kip", express.raw({ type: "application/json" }), (req, res) => {
  if (!isFromKip(req.body, req.get("X-KIP-Signature"), process.env.KIP_WEBHOOK_SECRET)) {
    return res.sendStatus(401);
  }
  res.sendStatus(200); // answer first, work after
  const event = JSON.parse(req.body.toString("utf8"));
  console.log(event.event, event.data.id);
});

app.listen(3000);

כל אירוע נשלח פעם אחת, ואנחנו מחכים לתשובה עד 5 שניות. ענו 2xx מיד ועבדו ברקע. השליחות האחרונות ותוצאותיהן מופיעות בהגדרות ← Webhooks.

מסמך OpenAPI

כל ה-API מתואר במסמך OpenAPI 3.1 אחד, באותה כתובת תמיד. טענו אותו ל-Postman, ל-Insomnia או לכלי שמייצר קוד לקוח, וקבלו את כל נקודות הקצה, השדות והשגיאות.

OpenAPI 3.1
https://kip.li/api/v1/openapi.json