בדיקת API של מערכת הנהלת חשבונות

בלוח הניהול: API ← בדיקת API של מערכת הנהלת חשבונות.

מה זה

ארגז חול עבור אינטגרציה עם מערכת הנהלת החשבונות שלכם. כאן רוכזו כל הנקודות, דרכן המערכת שלנו בעצמה מתקשרת למערכת הנהלת החשבונות: שואלת מחירים, בודקת זמינות במחסן, מושכת קישורי חומר↔קצה וכו'. בעמוד רואים אילו endpoint מוגדרים אצלכם, ואילו לא; את כל אחד אפשר לבדוק חי בבקשה אמיתית ולראות מה מערכת הנהלת החשבונות החזירה.

מה אתם רואים

רשימת נקודות הפנייה למערכת הנהלת החשבונות — כרטיסים עם מבנה זהה:

• שם ותיאור קצר של הנקודה.
• מה זה נותן — במילים פשוטות: איזו פונקציונליות הגדרת endpoint זה מפעילה.
• שלבי הגדרה — הוראה קצרה: מה לבקש מהמתכנת של מערכת הנהלת החשבונות שלכם, איזה מפתח פרמטר למצוא בלוח הניהול, היכן להדביק את ה-URL.
• URL נוכחי — אם כבר מוגדר. ריק — סימן ש-endpoint לא עובד.
• כפתור „בדיקה" — עובר ללשונית עם טופס בקשה אמיתית, מציג request/response.

נקודות אינטגרציה זמינות

סט בסיסי (יכולים להיווסף עם התפתחות המערכת):

• קבלת מחירי חומרים — המערכת שלנו שואלת את מערכת הנהלת החשבונות על מחירים עדכניים של חומרים לוחיים. ללא הגדרה זו המחירים נלקחים ממסד הנתונים המקומי ועלולים להיות שונים ממערכת הנהלת החשבונות.
• קבלת מחירי שירותים — אותו דבר עבור שירותים (עיבוד, אביזרים).
• בדיקת זמינות במחסן — לפני הזנת הזמנה לייצור המערכת שואלת את מערכת הנהלת החשבונות האם יש את כל החומרים הנדרשים. ללא זה הזמנות עלולות להגיע לייצור וליפול עם „אין חומר".
• קבלת קצה לחומר — איזה קצה מגיע בערכה עם חומר לוחי מסוים. בשימוש בסנכרון הקטלוג; אחרת התאמת חומר→קצה צריכה להיות מוגדרת ידנית.

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

איך להגדיר

המתכון הכללי זהה לכל נקודה:

1. לבקש מהמתכנת של מערכת הנהלת החשבונות שלכם ליצור שירות HTTP (endpoint) עם פורמט הבקשה/תגובה הנדרש. תיאור הפורמט — בתוך הכרטיס בעמוד הבדיקה.
2. לקבל מהמתכנת את ה-URL של שירות זה (חייב להתחיל ב-https://; מערכת הנהלת חשבונות מקומית יכולה להיות ב-http://).
3. להיכנס ל-פרמטרים ← פרמטרי החברה, למצוא את הפרמטר עם המפתח שצוין בכרטיס ולהדביק את ה-URL.
4. לחזור לעמוד הבדיקה וללחוץ „בדיקה" — מיד רואים האם מערכת הנהלת החשבונות עונה ואילו נתונים מחזיר.

בדיקת בקשה

בלשונית הבדיקה של הנקודה הנבחרת אתם רואים:

• Endpoint URL — לאן תטוס הבקשה.
• שיטת HTTP (בדרך כלל POST).
• כותרות (כולל API-Key של מערכת הנהלת החשבונות אם מוגדר).
• גוף הבקשה — דוגמה אופיינית שניתן לשלוח מיד או לתקן (לדוגמה, להציב code1c אמיתי של מוצר/הזמנה קיימים).
• כפתור „שלח" — נותן תגובה גולמית ממערכת הנהלת החשבונות: קוד תגובה, גוף, משך.

מה חשוב

• בקשות בדיקה הן אמיתיות: הן באמת הולכות למערכת הנהלת החשבונות שלכם ויכולות לשנות את הנתונים שלו (לדוגמה, בדיקת „קבל הזמנה" תיצור רשומה במערכת הנהלת החשבונות). היו זהירים בייצור — קודם בדקו על staging של מערכת הנהלת החשבונות.
• כל הגדרות הנקודות מאוחסנות בפרמטרי הייצור של החברה שלכם — ניתן לשנות ללא פריסה מחדש.
• באחד המפתחות במערכת קיימת היסטורית טעות הקלדה („avilable" במקום „available") — זה לא באג, נשמר עבור תאימות להתקנות ישנות. רמז בכרטיס יזהיר.
• גישה — כל מנהלי החברה שלכם.

הערות כלליות

כל ההגדרות במדור הזה ניתנות לעריכה בכל זמן דרך לוח הניהול. השינויים נכנסים לתוקף מיד לאחר השמירה — אין צורך בהפעלה מחדש של המערכת או בפעולת deploy. היסטוריית השינויים נשמרת אוטומטית, כך שניתן לחזור למצב קודם אם נדרש לבטל פעולה.

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

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

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

לתיעוד נוסף על נושאים קשורים — עיינו במאמרים אחרים באותה קטגוריה במדריך, או השתמשו בחיפוש לפי מילת מפתח.