API

ה-API של Gem Logic מאפשר לכם להשתלב עם מערכות חיצוניות ולבצע אוטומציה של תהליכי עבודה. תוכלו להשתמש בו לניהול מוצרים, מכירות, איש קשר, תיקונים, ספירות מלאי ומשימות הדפסה בצורה תכנותית.

עברו אל הגדרות ‣ API ליצירה וניהול של מפתחות ה-API שלכם.

אימות

כל בקשות ה-API חייבות לכלול מפתח API בכותרת HTTP‏ x-api-key. תוכלו ליצור מפתחות מעמוד הגדרות ‣ API. ניתן לנטרל או למחוק מפתחות בכל עת.

דוגמה לבקשה:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

סכנה

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

כתובת בסיס

כל נקודות הקצה יחסיות לכתובת המופע שלכם, תחת קידומת /api/:

https://your-instance.gem-logic.com/api/

פורמט תגובה

כל התגובות מוחזרות כ-JSON. בקשות מוצלחות מחזירות קוד סטטוס 200 (עבור GET) או 201 (עבור POST). שגיאות מחזירות את קוד הסטטוס המתאים עם הודעה:

• 200 OK — בקשת GET מוצלחת

• 201 Created — בקשת POST מוצלחת

• 400 Bad Request — נתונים לא תקינים או חסרים

• 401 Unauthorized — מפתח API לא תקין או חסר

• 404 Not Found — המשאב אינו קיים

נקודות קצה

ערוצי מכירה

שיטה	GET
URL	/api/marketplaces/
תיאור	מחזיר רשימה של כל ערוצי המכירה.

שדות תגובה:

שדה	סוג	תיאור
id	integer	מזהה ייחודי
marketplace	string	שם Marketplace

מוצרים

רשימת מוצרים

שיטה	GET
URL	/api/products/{marketplace_id}
תיאור	מחזיר מוצרים מסוננים לפי marketplace. השתמשו במזהה ה-marketplace מנקודת הקצה של marketplaces.

שדות תגובה:

שדה	סוג	תיאור
id	integer	מזהה ייחודי
item_sku	string	מק״ט מוצר
created	datetime	תאריך יצירה
status	string	סטטוס מוצר
images	array	רשימת תמונות מוצר (id, image)
item_weight	decimal	משקל
item_height	decimal	גובה
item_length	decimal	אורך
item_width	decimal	רוחב

יצירת תמונת מוצר

שיטה	POST
URL	/api/products/create/image/
תיאור	העלאת תמונת מוצר באמצעות קידוד base64. אם מק״ט המוצר עדיין לא קיים, מוצר חדש נוצר באופן אוטומטי.

שדות הבקשה:

שדה	סוג	נדרש	תיאור
item_sku	string	כן	מק״ט המוצר שאליו יש לצרף את התמונה
image	string (base64)	כן	נתוני תמונה מקודדים ב-base64

מכירות

רשימת מכירות

שיטה	GET
URL	/api/sales/
תיאור	מחזירה רשימה של כל הזמנות המכירה.

שדות תגובה:

שדה	סוג	תיאור
order_id	string	מזהה ייחודי של ההזמנה

יצירת מכירה

שיטה	POST
URL	/api/sales/create/
תיאור	יוצרת הזמנת מכירה חדשה.

אנשי קשר

שיטה	GET
URL	/api/contacts/
תיאור	מחזירה רשימה של כל אנשי הקשר.

שדות תגובה:

שדה	סוג	תיאור
id	integer	מזהה ייחודי
complete_name	string	שם מלא
contact_type	string	סוג איש קשר
email	string	כתובת דוא״ל
phone	string	מספר טלפון
language	string	שפה מועדפת

תיקונים

יצירת תיקון

שיטה	POST
URL	/api/repairs/create/
תיאור	יוצר הזמנת תיקון חדשה עם פריט תיקון משויך. אם ערוץ מכירות או מחלקה אינם מסופקים, נעשה שימוש בראשונים הזמינים.

שדות הבקשה:

שדה	סוג	נדרש	תיאור
client_id	integer	לא	מזהה של הלקוח/איש הקשר
marketplace	מחרוזת / מספר שלם	לא	מזהה או שם של ערוץ המכירות
division_id	integer	לא	מזהה מחלקה עסקית
title	string	לא	כותרת או תיאור של פריט התיקון
repair_info_1	string	לא	הערת תיקון נוספת
repair_info_2	string	לא	הערת תיקון נוספת
repair_info_3	string	לא	הערת תיקון נוספת
quantity	decimal	לא	כמות (ברירת מחדל: 1)
weight	decimal	לא	משקל הפריט
weight_unit	string	לא	יחידת מדידת משקל
size	string	לא	גודל הפריט
color	string	לא	צבע הפריט
engravement	string	לא	טקסט חריטה
client_reference | string		לא	מספר אסמכתא של הלקוח

דוגמה לתגובה:

{"message": "Repair created successfully.", "order_id": "R-0001"}

הוספת פריט לתיקון

שיטה	POST
URL	/api/repairs/add-item/
תיאור	מוסיף פריט חדש להזמנת תיקון קיימת.

שדות הבקשה:

שדה	סוג	נדרש	תיאור
order_id	string	כן	מזהה הזמנה של התיקון להוספת הפריט
item_sku	string	לא	מק״ט מוצר לקישור עם הפריט
title	string	לא	כותרת או תיאור
repair_info_1	string	לא	הערת תיקון נוספת
repair_info_2	string	לא	הערת תיקון נוספת
repair_info_3	string	לא	הערת תיקון נוספת
quantity	decimal	לא	כמות (ברירת מחדל: 1)
weight	decimal	לא	משקל הפריט
weight_unit	string	לא	יחידת מדידת משקל
size	string	לא	גודל הפריט
color	string	לא	צבע הפריט
engravement	string	לא	טקסט חריטה
client_reference | string		לא	מספר אסמכתא של הלקוח
cost	decimal	לא	עלות הפריט

ספירות מלאי

יצירת ספירת מלאי

שיטה	POST
URL	/api/inventory-counts/
תיאור	יוצר סשן ספירת מלאי חדש.

שדות תגובה:

שדה	סוג	תיאור
id	string	מזהה ספירת מלאי
created_at	datetime	חותמת זמן יצירה
status	string	תמיד active
tag_count	integer	מספר מוצרים שנספרו

הצגת מוצרי ספירת מלאי

שיטה	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
תיאור	מחזיר את כל המוצרים שנספרו בספירת מלאי מסוימת.

שדות תגובה:

שדה	סוג	תיאור
id	string	מזהה ייחודי
created_at	datetime	מתי המוצר נספר
product_sku	string	מק״ט מוצר
product_name	string	שם מוצר
quantity	integer	כמות שנספרה

עבודות הדפסה

שיטה	POST
URL	/api/print-pdf/
תיאור	העלאת קובץ PDF לתור ההדפסה עבור מדפסת ספציפית. הקובץ מאומת לפורמט ואבטחה. גודל קובץ מקסימלי הוא 20 MB. השתמשו בסוג תוכן multipart/form-data.

שדות הבקשה:

שדה	סוג	נדרש	תיאור
pdf	קובץ	כן	קובץ PDF להדפסה (מקסימום 20 MB)
printer_uuid	UUID	כן	UUID של מדפסת היעד
landscape	בוליאני	לא	הדפסה במצב אופקי (ברירת מחדל: false)

דוגמה לבקשה:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

דוגמה לתגובה:

{"status": "queued", "print_job_id": 42}

סייר API אינטראקטיבי

Gem Logic כולל סייר API אינטראקטיבי מובנה המופעל על ידי Swagger UI. תוכלו לגשת אליו דרך הקישור תיעוד API בדף הגדרות ‣ API. הסייר מאפשר לכם לנסות כל נקודת קצה ישירות מהדפדפן שלכם.

ראה גם

• אינטגרציות