סביבת בדיקה לממשק ה-API: לבדוק חיבור בלי לגעת בנתונים האמיתיים

כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק

45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.

מדריך למשתמש לסביבת הבדיקה של ממשק ה-API בביג בוס

קודם בודקים, אחר כך מחברים

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

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

שימו לב: הסביבה נוצרת מתוך "ניהול ממשק Api", ולכן צריך שתוסף ממשק API יהיה פעיל.

מה זו סביבת הבדיקה

מעל "רש' מזהים", ב"ניהול ממשק Api", יש כרטיס שמסביר את הסביבה במילים האלה:

"סביבת בדיקה היא חברה נפרדת עם מפתח משלה, שבה אפשר לבדוק חיבור בלי לגעת בנתונים האמיתיים. מסמכים בה לא נשלחים לרשות המסים, מיילים נשלחים רק אליכם, וכל מסמך מסומן "מסמך בדיקה". סביבה שלא נעשה בה שימוש 90 יום נמחקת (מייל אזהרה 14 יום לפני)."

הכרטיס של סביבת הבדיקה, מעל רשימת המזהים, עם הכפתור "צור סביבת בדיקה".

יצירת הסביבה

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

השאלה לפני שהסביבה נוצרת.

2. מעתיקים את המפתח
נפתח החלון "סביבת הבדיקה נוצרה": "זו הפעם היחידה שהמפתח של סביבת הבדיקה מוצג במלואו. העתיקו אותו עכשיו – אחר כך יוצגו רק 4 התווים האחרונים. איבדתם אותו? לחצו "החלף מפתח" בכרטיס סביבת הבדיקה." לוחצים "העתק מפתח Api", שומרים את המפתח, ואז "שמרתי".

החלון "סביבת הבדיקה נוצרה". בצילום המפתח מטושטש.

3. שולחים בקשות
שולחים את הבקשות לאותה כתובת של הממשק, רק עם המפתח של הסביבה בשדה api_token. למשל, customer_list בסביבה חדשה מחזירה לקוח אחד:

{
  "api_token": "<המפתח שלכם>",
  "page": 1
}

הכרטיס של הסביבה

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

הכרטיס "סביבת בדיקה פעילה": המפתח המוסתר, התאריכים, "החלף מפתח" ו"מחק סביבה".

נסו את מערכת ביג בוס לניהול העסק ל-45 יום בחינם >>

מה יש בסביבה, ומה חסום בה

הסביבה לא מעתיקה נתונים מהעסק שלכם. בסביבה חדשה יש:

לקוח אחד: "לקוח מזדמן".
שלושה פריטים לדוגמה, בלי מק״ט ולא מנוהלים במלאי, ושלוש קטגוריות פריטים.
אין מסמכים, אין מלאי ואין הרשמות ל-Webhook. document_list מחזירה 204 "לא נמצאו מסמכים", ו-webhook_list מחזירה 204 "לא נמצאו הרשמות".

חלק מהתחומים חסומים בה. ספקים והוצאות נדחים ב-403 "תוסף מעקב הוצאות אינו פעיל עבור המנוי", ולידים ומשימות ב-403 "תוסף CRM אינו פעיל עבור המנוי". את החיבור של התחומים האלה בודקים בזהירות בנתונים האמיתיים, למשל קודם במפתח "קריאה בלבד", ורק אחר כך בכתיבה.

מסמך בדיקה

מסמך שנוצר בסביבה מקבל מספור משלה: בבדיקה שלנו הצעת המחיר הראשונה קיבלה את המספר 1. בקובץ ה-PDF של המסמך מופיע הכיתוב "מסמך בדיקה" באלכסון, באדום, ובראש הדף השורה "מסמך בדיקה מסביבת בדיקה של ממשק Api – אינו מסמך חשבונאי ולא דווח לרשות המסים".

הכיתוב "מסמך בדיקה" על קובץ ה-PDF של מסמך מהסביבה.

השורה שבראש מסמך מסביבת הבדיקה.

מחיקה, ו-90 יום

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

השאלה לפני מחיקת הסביבה.

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

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

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

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

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

נסו את מערכת ביג בוס לניהול העסק ל-45 יום בחינם >>

יש שאלה לפני שמתחילים? דברו איתנו