תיעוד ה־API הציבורי של כל כלב
תיעוד לקריאה בלבד של ה־API הציבורי של כל כלב לחיפוש כלבים ונתונים מצטברים.
ממשק לקריאה בלבד
ה־API מחזיר מידע ציבורי בלבד על כלבים שמופיעים בכל כלב. רשומות מוסתרות ומידע שאינו ציבורי אינם נכללים בתשובות.
זמינות לאימוץ אינה מובטחת בזמן אמת. יש לאשר זמינות ופרטים מול מקור האימוץ המקורי.
נקודות קצה
-
GET /api/public/dogsרשימת כלבים ציבוריים עם סינון ועימוד מבוסס סמן.
/api/public/dogs?region=south&size=small&limit=5 -
GET /api/public/dogs/:idפרטי כלב ציבורי יחיד לפי מזהה יציב.
/api/public/dogs/<dog-id> -
GET /api/public/statsסיכומים מצטברים על רשומות הכלבים הציבוריות.
/api/public/stats
מסננים נתמכים
region- north, south, center, sharon או jerusalem
city- שם עיר נתמך בעברית או כינוי אנגלי מתועד
sex- male, female או unknown
size- small, small-medium, medium, medium-large, large או unknown
minAge- גיל מינימלי ידוע בשנים, בין 0 ל־30
maxAge- גיל מקסימלי ידוע בשנים, בין 0 ל־30
status- available בלבד
limit- מספר תוצאות; ברירת המחדל 20 והמקסימום 50
cursor- סמן אטום שהוחזר בבקשה קודמת עם אותם מסננים
ברירת המחדל היא 20 תוצאות, והמקסימום הוא 50. עימוד משתמש ב־nextCursor אטום ובאותם מסננים.
משמעות שדות חסרים
goodWithCats: null
לכל כלב אין כרגע מידע מהימן על התאמה לחתולים. מידע לא ידוע אינו מוצג כתשובה שלילית.
goodWithCats: false
המידע הציבורי הזמין מציין שהכלב אינו מתאים לחתולים.
lastCheckedAt
מועד בדיקת הזמינות או המקור האחרון שמיוצג במודל הנתונים הנוכחי של כל כלב; אין זו זמינות בזמן אמת.
דוגמת תשובה
הדוגמה משתמשת רק בשדות שמוחזרים על ידי רשימת ההרשאה הציבורית.
{
"dogs": [
{
"id": "public-dog-id",
"name": "לולה",
"sex": "female",
"ageYears": 2,
"size": "small",
"city": "אשדוד",
"region": "south",
"description": "תיאור ציבורי של כלבה שמחפשת בית.",
"goodWithDogs": true,
"goodWithCats": null,
"goodWithChildren": false,
"status": "available",
"lastCheckedAt": "2026-08-28T10:30:00.000Z",
"image": {
"url": "https:\/\/example.org\/lola.jpg",
"alt": "לולה לאימוץ"
},
"source": {
"name": "מקור אימוץ ציבורי",
"url": "https:\/\/example.org\/adopt\/lola"
},
"pageUrl": "https:\/\/kolklav.co.il\/dogs\/lola-public-dog-id"
}
],
"meta": {
"count": 1,
"limit": 5,
"nextCursor": null,
"generatedAt": "2026-08-29T00:00:00.000Z",
"disclaimer": "Availability should be confirmed with the original adoption source."
}
}
קצב שימוש ומגבלות
הגישה הציבורית מוגבלת ל־60 בקשות בדקה לכל כתובת IP. חריגה מוחזרת כשגיאה קריאה למכונה.
נתוני התאמה חסרים יכולים להיות null. ערך כזה מציין מידע לא ידוע, ואינו שקול ל־false.