API למפתחים

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

לבדיקה חד-פעמית של מספר בודד אין צורך במפתח — יש טופס בדיקה בדף הבית. המפתח נועד לבדיקות מתוך מערכת.

אימות

כל בקשה נושאת מפתח API בכותרת. מפתחות מונפקים על ידי True Kosher; לקבלת מפתח פנו ל-support@truekosher.org.

# אחת מהשתיים:
X-Api-Key: tk_xxxxxxxxxxxxxxxx
Authorization: Bearer tk_xxxxxxxxxxxxxxxx

GET https://api.truekosher.org/public/v1/check?number=<phone>

שם	סוג	תיאור
`number`	string	מספר הטלפון לבדיקה. פורמט מקומי (`0501234567`) או בינלאומי (`+972501234567`).

curl -H "X-Api-Key: tk_xxxxxxxxxxxxxxxx" \
  "https://api.truekosher.org/public/v1/check?number=0501234567"

{
  "number": "0501234567",
  "protected": true,
  "provider": "hadran",
  "checked_at": "2026-08-07T13:28:08Z"
}

שדה	תיאור
`protected`	האם המספר פועל כרגע ממכשיר מסונן עם תעודה פעילה.
`provider`	מזהה הסינון — מוחזר רק אם בעל המספר בחר לחשוף זאת. אחרת מושמט.
`checked_at`	חותמת זמן (UTC) של הבדיקה.

פרטיות: ה-API מחזיר אך ורק את סטטוס ההגנה (ואת הסינון אם אושר). שם המנוי או כל תוכן אישי לעולם לא מוחזרים דרך ה-API.

לכל מפתח מגבלת בקשות לדקה (ברירת מחדל 10, ניתנת להתאמה). כל תגובה כוללת:

`X-RateLimit-Limit`	המכסה לדקה.
`X-RateLimit-Remaining`	כמה נותרו בחלון הנוכחי.

חריגה מהמכסה מחזירה 429 Too Many Requests עם Retry-After.