קונימבו - חנויות מקצועיות באינטרנט

דוקומנטציה ויכולות

בשונה מV1 בAPI של קונימבו, V2 מאפשר קריאה של מידע בלבד.

מדובר על קובץ היברידי שמוגדר בצורה מסויימת ומפיק URL, לאחר הפקת הURL הוא מכיל JSON עם כל המידע לפי ההגדרות של ההיברידי.

כל ההיברידיים לדוגמא נמצאים בחנות v2examples.

קובץ V2 תמיד יהיה לא פעיל בחנות.

רשימת המודולים:

מוצרים - משלוחים - לקוחות - מבצעים והנחות - תגים - קטגוריות - קופונים - יצרנים - הזמנות

מבנה היברידים של V2:

תג: בשדה זה נבחר את המקור ממנו נשלוף את המוצרים.

feed url: לאחר שמירה ראשונה או שניה בשדה זה יופיע הלינק הבסיסי לV2 

https://app.konimbo.co.il/api/v2?storeId=6095&token=e7b9942492040abb97b770729ca1bbf55aa58dfc02b829d9481f17d9db2173151e1f19c846552e1a&groupName=group1&modelName=item

הלינק בנוי מ:

storeId - מזהה החנות

token - הטוקן הפנימי של ההיברידי

groupName - דיפולטיבי group1

modelName - שם המודול

*אין צורך למחוק את הלינק כדי לעדכן את הקובץ.

headerToken: עדן יבדוק

headers: הפורמט של המידע כותבים {"Content-Type": "application/json; charset=utf-8"}

body: מגיע ריק בדיפולט. בשדה זה ניתן לבצע מניפולציה בקוד שחוזר בעזרת EJS.

modelName - מגיע בדיפולט שם המודול עצמו

columns - מכיל את השדות שרוצים לשלוף בהתאם למודול

modelId - עדן יבדוק

engine - EJS

filters - שדה זה מתעדכן לפי מה שנבחר בשדה תג

function_names - הרחבות למודולים כדי לאפשר שליפה של נתונים

פרמטרים בURL:

אנחנו יכולים לשרשר  לURL של המודול,

פרמטרים page + perPage:

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

אופציה אחת היא להוריד שדות שלא בשימוש כדי להקטין את גודל הקובץ, 

אופציה שניה היא לחלק לעמודים על ידי הוספת הפרמטרים

&perPage=100&page=100

פרמטר perPage יגדיר כמה מוצרים נקבל בכל עמוד.

פרמטר page יגדיר את איזה עמוד אנחנו קוראים.

*אם נוסיף רק פרמטר של page אז המידע יחולק אוטומטית ל1000 מוצרים בעמוד.

פרמטר updatedAt:

ניתן להוסיף פרמטר זה כדי לקבל רק מוצרים שעודכנו בX שעות שנזין לתוך הפרמטר

כך למשל אם נרצה לקבל רק את המוצרים שעודכנו ב24 השעות האחרונות נוסיף את הפרמטר כך

&updatedAt=24

מודול מוצרים

כך נראה הלינק הבסיסי של מודול מוצרים:

https://app.konimbo.co.il/api/v2?storeId=6095&token=e7b9942492040abb97b770729ca1bbf55aa58dfc02b829d9481f17d9db2173151e1f19c846552e1a&groupName=group1&modelName=item

ניתן להוסיף פרמטרים שונים כדי לקבל סוגים שונים של מידע - 

לדוגמא פרמטר ID:

&itemIds=4791552,4791810

כאשר מוסיפים בפרמטר הזה את הID של מוצרים מסויימים מופרדים בפסיקים אז ה-JSON יכיל רק את אותם המוצרים.

פרמטר storeCategoryId:

ניתן להוסיף פרמטר של storeCategoryId שהוא בעצם ID של קטגוריה ולקבל בחזרה ב-JSON רק מוצרים מתוך הקטגוריה הזו

&storeCategoryId=251523

כל הפרמטרים לפיהם ניתן לפלטר:

storeCategoryId גל

storeCategoryIds גל

tagId גל

*לבדוק בנוגע להצגת השדות בקובץ הנוכחי - עדן 

לינק לשדות הקיימים בV2 https://konimbo.freshdesk.com/support/solutions/articles/4000206597 

מודול משלוחים

https://app.konimbo.co.il/api/v2?storeId=6095&token=b8c3970d0af758bd346ce17cb332b9ca3bd6cb3f92673e977b05b02f06cab96aa53a074447cf65da&groupName=group1&modelName=shipping_option

מודול לקוחות

https://app.konimbo.co.il/api/v2?storeId=6095&token=fcaf513aeae2e25b94fe17a4daa8a31dcd1a6b4326912e0de29f96db9f9462b2864501ed27d643c9&groupName=group1&modelName=customer

מודול מבצעים והנחות

https://app.konimbo.co.il/api/v2?storeId=6095&token=827d102c3a14f2cb81147c1b14875f885916d9528719e7f3daa1e812e9ece7cb70c59c2375a95251&groupName=group1&modelName=discount

מודול תגים

https://app.konimbo.co.il/api/v2?storeId=6095&token=b9b299b0629042302e3da214f114ad12548c1c0277c7efb3b1c379b94a0fd1697ee486cb44e6da21&groupName=group1&modelName=tag

מודול קטגוריות

https://app.konimbo.co.il/api/v2?storeId=6095&token=7eafe6f3ade85d53df6272eb41e7923dda6a745be8d1a167829b6f3d7ca82cc4f296f2c0a1817aef&groupName=group1&modelName=store_category

מודול קופונים

https://app.konimbo.co.il/api/v2?storeId=6095&token=e057e750e32ee68a5aa5e93f7126fae96d150ae4cee50d234ea841c53430daf0e0951bec7bb5a908&groupName=group1&modelName=coupon

מודול יצרנים

https://app.konimbo.co.il/api/v2?storeId=6095&token=a570fe932088bacd4d9a744dab6e0d503666ec9277d3337934d4a05c2d158dff5b0c5fcb498081d9&groupName=group1&modelName=group_value

במודול זה נדרש להוסיף את ID של רשימת היצרנים לשדה "belongsToId"

מודול הזמנות

https://app.konimbo.co.il/api/v2?storeId=6095&token=4378778826d0221d533c7f38b7c16d73cb8fd2d82bfc74f0baa4610a01668cfeaf1a6f026bbdf590&groupName=group1&modelName=order

הערות:

• כדי להוריד שדות / פונקציות לא נחוצים יש להוריד את ה V משם השדה ב columns או function_names 

• כדי שלא תהיה שגיאה בקובץ תמיד חייב להיות מסומן לפחות שדה אחד ב columns ושדה אחד ב function_names 

• במקרה וביצעתם שינויים בV2 והפיד לא מעודכן ומציג את המידע הישן יש להוסיף פרמטר לURL 

&cache={randomNumber}

• ניתן לבצע מניפולציות על המידע שנמשך בפיד ולתת התניות בהתאם לצרכי הלקוח

לדוגמא: לשלוף רק את המוצרים שאין להם מקט או שאין להם מלאי וכו