המאמר הזה מסביר בקצרה מה זה API, איך ה־API של mypips עובד, איך מנהל/ת חנות יוצרים מפתח API, ולמי כדאי לצלול לתוך התיעוד המלא.
💡 למי זה מתאים?
מנהלי חנות שרוצים להבין מה אפשר לעשות עם API ולפתוח חיבור למערכת חיצונית, ומפתחים ושותפים טכנולוגיים שרוצים לחבר מערכת חיצונית ל־mypips.
מה זה API?
API (או Application Programming Interface) הוא ממשק שבה שתי תוכנות מדברות אחת עם השנייה. במקום שאדם יפתח את הממשק הגראפי באפליקציה או דפדפן וילחץ על כפתורים כדי לבצע פעולות, באמצעות ה API אפשר לגרום לתוכנות אחרות לבצע פעולות עבורנו בצורה אוטומטית ובקנה מידה (סקייל) גדול.
ה־API של mypips
פיתחנו את mypips API באופן בו לכל חנות בפלטפורמה יש אפשרות לגשת באמצעות API לנתוני החנות באופן פרטי ומאובטח. ה API זמין לכל החנויות כבר עכשיו וכל שעליכם לעשות הוא לייצר מפתח ולהתחיל להשתמש או לבנות מעליו את מה כל שתרצו.
להלן מספר דוגמאות לאופן השימוש ב API:
למשוך נתונים על הזמנות, מוצרים, לקוחות ומלאי למערכת חיצונית (CRM, BI, מערכת הנהלת חשבונות).
לעדכן מוצרים ומחירים באופן אוטומטי ממערכת ניהול קיימת.
לסנכרן מלאי בין חנויות או מול ספק או מול קופה רושמת בעסק.
לחבר אוטומציות (Make, Zapier, n8n) לתהליכים פנימיים או שיווקיים.
לבנות אינטגרציה ייחודית לעסק שלכם.
🏆 שימו לב! כל פעולה ב־API עוברת בדיקות הרשאה וכל מפתח ניתן לשימוש מול חנות אחת בלבד. כדי לעבוד מול מספר חנויות במקביל מעל ה API עליכם לייצר מפתח נפרד עבור כל חנות.
יצירת מפתח API
מפתח API הוא הזיהוי (או סיסמה) שבעזרתו מערכת חיצונית מתחברת לחנות שלכם. בלי מפתח, אין גישה. מנהל/ת החנות יוצרים את המפתח מתוך הגדרות החנות, ומחליטים בדיוק לאיזה מידע יש לו גישה.
💡 לפני שמתחילים:
רק משתמש עם הרשאת ניהול כללי בחנות יכול ליצור מפתחות. אפשר ליצור מפתח אחד לכל חנות במסלול ה Superstar ועד 5 מפתחות לכל חנות במסלול ה Dream Team.
שלב 1: כניסה למסך ניהול המפתחות
היכנסו לחנות שלכם, ועברו ל־הגדרות חנות ומערכת > התממשקויות. תחת הכותרת ניהול מפתחות API תראו את רשימת המפתחות הקיימים בחנות, וכפתור צור מפתח חדש.
שלב 2: יצירת מפתח חדש
לחצו על צור מפתח חדש. בחלון שנפתח, תנו למפתח שם פנימי שיעזור לכם לזהות אותו אחר כך (למשל "Zapier של דנה", "AI Agent", "סנכרון חשבונאות").
השם הזה לא נחשף החוצה, הוא בשבילכם בלבד, כדי שתדעו איזה מפתח שייך לאיזה חיבור.
שלב 3: בחירת הרשאות
לכל מפתח אפשר להגדיר במדויק לאיזה מידע בחנות יש לו גישה, ואם הוא יכול רק לקרוא או גם לעדכן. הרשאה ניתנת לכל סוג משאב בנפרד: לקוחות, הזמנות, מוצרים, מלאי, משלוחים, ספקים, מבצעים וקודי קופון, תוכן, דפים מותאמים, מדיה, ועוד.
חלק מהמשאבים זמינים לקריאה בלבד (תנועות, חשבוניות, מחירונים, דוחות), בגלל הרגישות שלהם.
🏆 כלל אצבע: תנו רק את ההרשאות שהמערכת המחוברת באמת צריכה. אם המערכת רק קוראת נתונים, אל תיתנו לה הרשאות עדכון. ככה גם אם משהו משתבש בצד השני, הנזק האפשרי קטן.
שלב 4: שמירת המפתח
לחצו על צור מפתח. mypips ייצור עבורכם מפתח ייחודי. זה הרגע להעתיק אותו ולשמור אותו במקום בטוח (מנהל סיסמאות, הגדרות המערכת המחוברת). מטעמי אבטחה, את המפתח המלא אפשר לראות רק פעם אחת.
אחרי שיצרתם, ברשימת המפתחות תראו לכל מפתח את התאריך שבו נוצר, את תאריך השימוש האחרון, ואת ההרשאות שניתנו לו.
ניהול שוטף
מתוך אותו מסך, לכל מפתח אפשר:
לערוך את השם וההרשאות שלו.
להשבית או למחוק את המפתח. ברגע שמפתח נמחק, כל מערכת שמשתמשת בו תפסיק לעבוד מולכם, מיד.
בעתיד - לצפות בנתוני השימוש ולראות מתי המפתח נוצל ולאילו פעולות.
🏆 שימו לב! אם יש חשד שמפתח דלף, מחקו אותו מיד וצרו אחד חדש.
עלויות ומגבלות שימוש
ב mypips תמיד דאגנו לשחרר כל פיצ׳ר וכל יכולת חדשה לכל הלקוחות שלנו ללא עלות נוספת. ולכן החלטנו שגם כאן, הגישה ל mypips API תהיה פתוחה לכל המסלולים ללא עלות נוספת לתקופת הרצה וניסיון. שימוש ב API יכול לגרור עלייה משמעותית בעלויות התשתית והנתונים של כל חנות ולכן אנחנו מנטרים ובוחנים את אופן והיקף העומסים של כל חנות.
בהתאם לשימוש, ייתכן שבעתיד הגישה ל API תוגבל או תלווה בעלויות נוספות.
תיעוד ומפרט טכני למפתחים
התיעוד המלא של ה־API מיועדת למפתחים וכוללת את המפרט הטכני, הפעולות, הפרמטרים הדוגמאות ועוד.
קישור לתיעוד: https://api.mypips.app/docs/api
בתיעוד תמצאו:
רשימת ה־endpoints הזמינים (קריאה וכתיבה).
מבנה הבקשות והתשובות.
איך מתחברים ומאמתים מול ה־API עם המפתח שיצרתם.
דוגמאות לקריאות נפוצות.
קישור לקובץ OpenAPI.yaml המכיל מפרט טכני מלא שניתן לטעון ב Postman להתנסות ובדיקות. הקובץ ניתן להורדה ישירה מכאן: https://api.mypips.app/docs/api/openapi.yaml
⁉️ שאלות נפוצות
1. אני לא מפתח/ת, ה־API רלוונטי לי?
לרוב, לא. אם יש לכם צורך באוטומציה או באינטגרציה, צרו את המפתח לפי השלבים למעלה, והעבירו אותו (יחד עם הקישור לתיעוד ה API) למפתח/ת או לאיש האינטגרציות שעובד איתכם.
אם אתם מחפשים פתרון בלי קוד, אפשר להתחיל עם החיבור ל־Claude ול־ChatGPT שמאפשר לבצע פעולות בחנות דרך שיחה. (ראו הדרכה נפרדת על mypips MCP שמאפשר חיבור סוכני AI ל API של החנות שלכם).
2. השימוש ב־API בטוח?
כן. גישה ל־API דורשת מפתח, ולכל מפתח יש הרשאות מוגדרות שהמערכת בודקת ומאמתת בכל קריאה ל API על-ידי אותו מפתח. אתם יכולים לראות, לעדכן, להשבית ולמחוק מפתחות בכל רגע מתוך הגדרות החנות.
3. כמה מפתחות אפשר ליצור?
עד מפתח אחד בכל חנות על מסלול Superstart ועד 5 מפתחות בכל חנות על מסלולי Dream Team. מומלץ ליצור מפתח נפרד לכל מערכת שמתחברת, כדי לזהות בקלות מי מבצע מה ולהשבית רק את מה שצריך אם משהו משתבש.
4. יש עלות לשימוש ב־API?
ה־API זמין בשלב זה ללקוחות mypips ללא תוספת תשלום. יש מגבלות קצב סבירות (rate limits) כדי לשמור על יציבות המערכת. הפרטים המלאים מופיעים בתיעוד ה API המלא.
🏆 טיפ
צריכים עזרה בבניית אינטגרציה? כתבו לנו ונחבר אתכם לחומר המתאים או לאיש הקשר הנכון.
הצטרפו לקהילה שלנו בוואטסאפ, ותהיו הראשונים להתעדכן בכל מה שקורה.