שגיאות API נפוצות

על מנת לעזור לכם לבצע חיבורי API למערכת Powerlink CRM בצורה קלה ומהירה, ריכזנו עבורכם אוסף של שגיאות API נפוצות.

 

ניתן להתממשק למערכת Powerlink בשתי דרכים:

1. Webform

2. Rest API

 

במאמר זה נתמקד בממשק Rest API.

 

המלצה חמה שלנו היא לקרוא בנוסף את המאמר על התחלת עבודה עם ממשק Rest API.

 

בנוסף, חשוב לציין כי קיים לרשותכם ממשק API Explorer אשר מאפשר לכם לבנות פקודות API בפורמט JSON, לקבל את סטטוס הפקודה ובכך למנוע טעויות טרם ביצוע ההתממשקות בפועל.

בשביל ללמוד בהרחבה על כלי ה-API Explorer היכנסו למאמר הבא או צפו בסרטון הדרכה.

 

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

 

1. הגעתם למגבלה של הרישיון בו אתם נמצאים במערכת Powerlink ישנם מספר סוגים של רישיונות, אחד מהפרמטרים אשר מבדילים ביניהם הוא מגבלת הרשומות. במידה וקיימת לכם התממשקות של לידים ואתם נמצאים ברישיון בו ניתן להזין עד 500 לקוחות, בניסיון הכניסה של הליד ה 501, תתקבל שגיאת API. מידע נוסף אודות סוגי הרישיונות שלנו תוכלו למצוא כאן.

 

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

 

3. שלחתם נתונים לרשומה שגויה (מספר רשומה שגוי) על מנת להעביר נתונים לרשומה מסוימת בצורה תקינה, אנו צריכים לפנות למספר הרשומה הספציפי בדיוק כפי שמופיע במערכת. במידה ונטעה במספר הרשומה, נקבל שגיאה או שהנתונים לא ייכנסו למקום הרצוי. ניתן למצוא את מספרי הרשומות במערכת במסך ההגדרות (גלגל שיניים אפור משמאל) > בתפריט "מערכת"> בלשונית "הגדרת רשומות". מספרי רשומות נפוצים: לקוחות - account מספר הרשומה: 1, קריאות שירות - cases מספר הרשומה: 5, משימות task מספר הרשומה: 10. הסבר על פעולות לקבלת שמות רשומות ושדות מערכת תוכלו למצוא במאמר הבא.

 

4 .שלחתם לשדה מסוג רשומה מקושרת את השם של הרשומה במקום את הID של הרשומה

שדה מסוג רשומה מקושרת הוא שדה בעל קישור לרשומה אחרת במערכת. על מנת להזין נתונים לשדה מסוג זה, יש להזין את הID של הרשומה המבוקשת ולא את השם שלה.
קראו במאמרים הבאים מידע נוסף על רשומה מקושרת בAPI ועל שאילתות לקבלת ID של רשומה.

 

5. שלחתם לשדה תיבת בחירה את הערך טקסטואלי במקום הערך המספרי של הערך בתיבת הבחירה

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

 

6. שלחתם לשדה מסוג מסוים, ערכים שהוא לא יכול מקבל

ישנם שדות המיועדים לקבלת ערכים מסוימים, לדוגמה שדה מספר לא יכול לקבל אליו טקסט אלא מספרים בלבד. דוגמה נוספת, שדה UTC, תאריך ו/או תאריך ושעה לא יכול לקבל ערכים שאינם בפורמט של תאריך או שעה: YYYY-MM-DDTHH:MM:SS.

 

7. שלחתם מלל ארוך לשדה אשר מוגבל בכמות התווים

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

 

8. שלחתם נתונים והזנתם TokenId שגוי

טוקן הינו ה"כתובת" של המערכת שלכם, במידה והזמנתם טוקן שגוי, הנתונים לא יכנסו למערכת.

 

9. שלחתם רשומה עם טוקן של משתמש שאין לו הרשאה מתאימה

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

 

10. שלחתם רשומה עם טוקן של משתמש לא פעיל

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

 

11. שלחתם נתונים ל-URL לא תקין

הURL לשליחת נתונים הוא https://api.powerlink.co.il/api/record/{record}
שימו לב כי הURL מתחיל ב-api ולא בapp- כמו בURL של המערכת.

 

לאיתור שגיאות API במערכת תוכלו להיעזר בכלי API LOG