تخطَّ إلى المحتوى

مرجع حمولة Webhook

النص JSON الذي يرسله Timemark عبر POST لحدث صورة جديدة، حقلًا بحقل.


تكتب نقطة النهاية التي تستقبل عمليات Webhook من Timemark، وتحتاج إلى معرفة الشكل الدقيق لنص الطلب لتتمكن من تحليله.

كل تسليم هو طلب HTTP من نوع POST بنص JSON. يحمل النص الحدث والصورة المعنية به. يجب أن تعيد نقطة النهاية الخاصة بك استجابة 2xx ضمن المهلة؛ أي شيء آخر يُحتسب تسليمًا فاشلًا وتُعاد محاولته.

هذا هو النص المُرسَل لحدث صورة جديدة (event_type: "photo.uploaded"):

{
"event_type": "photo.uploaded",
"event_id": "3f4566da-938d-4e11-834b-ba9e3faec98c",
"group_name": "Group Scenery",
"project_name": "Project Sunrise",
"photo_code": "A1BCDEFGHIJ23K",
"photo_name": "2025-12-11 13.45.00_1388 Central Park, New York, example.jpg",
"photo_url": "https://example.com/uploads/photos/123456.jpg",
"thumbnail_url": "https://example.com/uploads/photos/123456.jpg",
"photo_timestamp": "2025-12-11T13:45:00Z",
"photo_location": {
"location_name": "Central Park, New York, USA",
"location_latitude": "40.785091",
"location_longitude": "-73.968285"
},
"member": {
"member_name": "Alice Chen",
"member_short_name": "Alice",
"member_profile_picture_url": "https://example.com/user/profile_photo/123456.jpg",
"member_contact": "alice.chen@example.com"
},
"device_model": "Apple iPhone 14 Pro Max",
"custom_notes": [
{
"title": "custom_note_title_1",
"content": "custom_note_content_1"
},
{
"title": "custom_note_title_2",
"content": "custom_note_content_2"
}
]
}
الحقلالنوعالوصف
event_typestringالحدث الذي أُطلق. photo.uploaded لحدث صورة جديدة.
event_idstringمعرّف فريد لهذا التسليم. استخدمه لإزالة تكرار المحاولات.
group_namestringالفريق الذي تنتمي إليه الصورة.
project_namestringالمشروع الذي تنتمي إليه الصورة.
photo_codestringرمز التحقق الخاص بالصورة، يُستخدم أيضًا في مركز التحقق من الصور.
photo_namestringاسم ملف الصورة، ويتضمن وقت التقاطها وموقعها.
photo_urlstringرابط URL للصورة بحجمها الكامل.
thumbnail_urlstringرابط URL للصورة المصغّرة.
photo_timestampstringوقت الالتقاط بصيغة ISO 8601 (بتوقيت UTC).
photo_locationobjectموقع الالتقاط. انظر أدناه.
photo_location.location_namestringاسم المكان أو العنوان بصيغة مقروءة.
photo_location.location_latitudestringخط العرض، كنص.
photo_location.location_longitudestringخط الطول، كنص.
memberobjectالعضو الذي التقط الصورة. انظر أدناه.
member.member_namestringالاسم الكامل المعروض.
member.member_short_namestringالاسم المختصر.
member.member_profile_picture_urlstringرابط URL للصورة الشخصية للعضو.
member.member_contactstringوسيلة التواصل مع العضو، مثل بريد إلكتروني.
device_modelstringالجهاز الذي التقط الصورة.
custom_notesarrayملاحظات مخصصة على الصورة. لكل عنصر title وcontent.
  • خطا العرض والطول نصّان، وليسا رقمَين. حوّلهما قبل إجراء أي عمليات حسابية.
  • أزل التكرار بالاعتماد على event_id. يكرر التسليم المُعاد نفس event_id، لذا خزّنه وتجاهل التكرارات.
  • أكّد الاستلام بسرعة، ثم عالج لاحقًا. أعد 2xx أولًا، ثم نفّذ المعالجة الثقيلة، وإلا عُومل التسليم كفاشل وأُعيدت محاولته.

آخر تحديث: