הצטרפות

פרויקטים ב-API

ניהול פרויקטים ב-API

ה-API מאפשר לנהל פרויקטים ממערכת חיצונית. כל פרויקט משויך ללקוח קיים — מציינים אותו באחד מהשדות: customer_id (המזהה הפנימי שחוזר מ-API הלקוחות), customer_external_id או customer_identification (ת.ז / ח.פ).

ה-endpoints

  • POST /api/projects/addProject — יצירת פרויקט. שדות חובה: לקוח (אחד מהשלושה) ו-name.
  • POST /api/projects/updateProject — עדכון פרויקט קיים לפי id (GUID) או external_project_id.
  • POST /api/projects/addOrUpdateProject — יצירה או עדכון (Upsert). ה-endpoint המומלץ לאינטגרציות.
  • POST /api/projects/searchProjects — חיפוש מעומד (paginated) לפי לקוח, סטטוס פעיל, וטווח תאריכי פרויקט.

שדות

  • name — שם הפרויקט (חובה ביצירה).
  • external_project_id — מזהה ממערכת חיצונית, משמש ל-Upsert.
  • project_date / project_end_date — תאריכים בפורמט dd/MM/yyyy (תאריך הפרויקט מוגדר להיום כברירת מחדל).
  • amount, currency_id, active, description, remarks.

דוגמה — יצירה או עדכון פרויקט:

POST /api/projects/addOrUpdateProject

{
  "api_key": "YOUR_API_KEY",
  "test": 0,
  "contact_email": "dev@example.com",
  "contact_phone": "050-1234567",
  "customer_external_id": "CRM-12345",
  "name": "אתר תדמית",
  "external_project_id": "PRJ-2026-001",
  "project_date": "01/06/2026",
  "amount": 25000
}

בתגובה חוזרים id (GUID) ו-project_id (מזהה פנימי) — שמרו אותם כדי לקשר אבני דרך ושעות עבודה לפרויקט.

תיעוד מלא: כל ה-endpoints והשדות, עם דוגמאות בכל שפה, בתיעוד ה-API האינטראקטיבי ובמדריך ה-API המלא למפתחים.

x

הצטרפות