{"info":{"name":"TikTak API","description":"## התחלה מהירה\n\nכל בקשה נושאת מפתח API בכותרת `Authorization`:\n\n```\ncurl https://tiktak.apps4all.net/api/v1 \\\n  -H \"Authorization: Bearer tk_live_...\"\n```\n\nמפתחות נוצרים במסך ההגדרות של הארגון. המפתח מוצג פעם אחת בלבד.\n\n## מצב בדיקה\n\nמפתח `tk_test_` כותב וקורא נתוני בדיקה בלבד. הם חיים באותו ארגון ועוברים את\nאותן בדיקות תקינות ואת אותה מכונת מצבים — אבל אינם נספרים במכסה החודשית,\nאינם מחויבים, ואינם מופיעים בלוח המשלוחים. מפתח `tk_live_` לא רואה אותם כלל.\n\n## אידמפוטנטיות\n\nכל בקשת כתיבה מקבלת כותרת `Idempotency-Key`. שליחה חוזרת עם אותו מפתח מחזירה\nאת אותה תשובה במקום לבצע את הפעולה שוב — זה מה שמונע משלוח כפול כשהחיבור\nנופל אחרי שהבקשה כבר הגיעה אלינו. מפתח שנשלח שוב עם תוכן שונה נדחה ב-409.\n\n## עימוד\n\nעימוד מבוסס סמן, לא דילוג. כל רשימה מחזירה `has_more` ו-`next_cursor`;\nהעבירו את הסמן כדי לקבל את העמוד הבא. הסמן אטום — אל תנתחו אותו.\n\n## שגיאות\n\nכל שגיאה מוחזרת באותו מבנה, עם `type` לסיווג גס, `code` יציב למכונה,\nו-`request_id` שכדאי לשמור בלוג — הוא מה שמאפשר לנו לאתר את הבקשה.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{api_key}}","type":"string"}]},"variable":[{"key":"base_url","value":"https://tiktak.apps4all.net","type":"string"},{"key":"api_key","value":"tk_test_replace_me","type":"string"}],"item":[{"name":"General","item":[{"name":"בדיקת מפתח","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1","host":["{{base_url}}"],"path":["api","v1"]},"description":"מחזיר את מצב המפתח, ההרשאות שלו והמסלול שהוא פועל בו. אינו דורש הרשאה."}}]},{"name":"Shipments","item":[{"name":"רשימת משלוחים","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/shipments","host":["{{base_url}}"],"path":["api","v1","shipments"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."},{"key":"status","value":"","disabled":true,"description":"רשימה מופרדת בפסיקים, למשל `pending,assigned`."},{"key":"service_date","value":"","disabled":true,"description":""},{"key":"external_id","value":"","disabled":true,"description":""},{"key":"reference","value":"","disabled":true,"description":""},{"key":"barcode","value":"","disabled":true,"description":""},{"key":"driver_id","value":"","disabled":true,"description":""},{"key":"route_id","value":"","disabled":true,"description":""}]}}},{"name":"יצירת משלוח","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Idempotency-Key","value":"{{$guid}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/shipments","host":["{{base_url}}"],"path":["api","v1","shipments"]},"body":{"mode":"raw","raw":"{\n  \"external_id\": \"ORD-1042\",\n  \"recipient\": {\n    \"name\": \"רונית לוי\",\n    \"phone\": \"052-123-4567\"\n  },\n  \"delivery_address\": {\n    \"raw\": \"דיזנגוף 100, תל אביב\",\n    \"notes\": \"קומה 3\"\n  },\n  \"service_date\": \"2026-08-21\",\n  \"items\": [\n    {\n      \"description\": \"חבילה\",\n      \"quantity\": 1,\n      \"weight_kg\": 3.5\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"name":"משלוח בודד","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/shipments/:id","host":["{{base_url}}"],"path":["api","v1","shipments",":id"]}}},{"name":"עדכון משלוח","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/shipments/:id","host":["{{base_url}}"],"path":["api","v1","shipments",":id"]},"description":"כתובת ומועד ניתנים לשינוי עד שהנהג אוסף את המשלוח. אחרי זה רק שדות שאינם משנים לאן הוא נוסע.","body":{"mode":"raw","raw":"{\n  \"driver_instructions\": \"להתקשר לפני ההגעה\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"ביטול משלוח","request":{"method":"DELETE","header":[],"url":{"raw":"{{base_url}}/api/v1/shipments/:id","host":["{{base_url}}"],"path":["api","v1","shipments",":id"]},"description":"ביטול, לא מחיקה. משלוח שנמסר הוא רשומה עסקית ולא ניתן להסרה דרך ה-API."}},{"name":"היסטוריית המשלוח","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/shipments/:id/events","host":["{{base_url}}"],"path":["api","v1","shipments",":id","events"]}}}]},{"name":"Routes","item":[{"name":"רשימת מסלולים","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/routes","host":["{{base_url}}"],"path":["api","v1","routes"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."},{"key":"status","value":"","disabled":true,"description":""},{"key":"service_date","value":"","disabled":true,"description":""},{"key":"driver_id","value":"","disabled":true,"description":""}]}}},{"name":"מסלול בודד","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/routes/:id","host":["{{base_url}}"],"path":["api","v1","routes",":id"]}}}]},{"name":"Drivers","item":[{"name":"רשימת נהגים","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/drivers","host":["{{base_url}}"],"path":["api","v1","drivers"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."}]}}}]},{"name":"Customers","item":[{"name":"רשימת לקוחות","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/customers","host":["{{base_url}}"],"path":["api","v1","customers"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."},{"key":"external_id","value":"","disabled":true,"description":""},{"key":"phone","value":"","disabled":true,"description":""}]}}},{"name":"יצירת לקוח","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Idempotency-Key","value":"{{$guid}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/customers","host":["{{base_url}}"],"path":["api","v1","customers"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"רונית לוי\",\n  \"phone\": \"052-123-4567\",\n  \"external_id\": \"CUST-88\",\n  \"address\": {\n    \"raw\": \"דיזנגוף 100, תל אביב\"\n  }\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Webhooks","item":[{"name":"רשימת כתובות webhook","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/webhooks","host":["{{base_url}}"],"path":["api","v1","webhooks"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."}]}}},{"name":"הוספת כתובת webhook","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/webhooks","host":["{{base_url}}"],"path":["api","v1","webhooks"]},"description":"ה-`secret` מוחזר פעם אחת בלבד, בתשובה הזו. שמרו אותו.","body":{"mode":"raw","raw":"{\n  \"url\": \"https://example.com/hooks/tiktak\",\n  \"events\": [\n    \"shipment.delivered\",\n    \"shipment.failed\"\n  ],\n  \"description\": \"עדכוני מסירה\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"כתובת webhook בודדת","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/webhooks/:id","host":["{{base_url}}"],"path":["api","v1","webhooks",":id"]}}},{"name":"עדכון כתובת webhook","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/webhooks/:id","host":["{{base_url}}"],"path":["api","v1","webhooks",":id"]},"body":{"mode":"raw","raw":"{\n  \"active\": true\n}","options":{"raw":{"language":"json"}}}}},{"name":"מחיקת כתובת webhook","request":{"method":"DELETE","header":[],"url":{"raw":"{{base_url}}/api/v1/webhooks/:id","host":["{{base_url}}"],"path":["api","v1","webhooks",":id"]}}},{"name":"יומן משלוחי ה-webhook","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/webhooks/:id/deliveries","host":["{{base_url}}"],"path":["api","v1","webhooks",":id","deliveries"],"query":[{"key":"limit","value":"","disabled":true,"description":""},{"key":"cursor","value":"","disabled":true,"description":"ה-`next_cursor` מהתשובה הקודמת."},{"key":"status","value":"","disabled":true,"description":""},{"key":"event","value":"","disabled":true,"description":""}]},"description":"מה נשלח, מתי, כמה ניסיונות, ומה השרת שלכם החזיר — כולל גוף התשובה."}},{"name":"שליחת אירוע בדיקה","request":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v1/webhooks/:id/test","host":["{{base_url}}"],"path":["api","v1","webhooks",":id","test"]},"description":"נשלח באותה חתימה ובאותו מבנה כמו אירוע אמיתי, כדי שתוכלו לאמת את הצד שלכם לפני שמשלוח אמיתי תלוי בזה."}}]}]}