מדריכי מוצר
מפתחות API
כדי להשתמש בAPI של Wbiztool, או באינטגרציה שמבקשת את פרטי הגישה שלכם, תצטרכו שלושה דברים ממרכז הבקרה:
| פרט גישה | שדה ב-API | איפה למצוא אותו |
|---|---|---|
| מזהה לקוח API (API Client ID) | client_id | Settings → API Keys (הגדרות ← מפתחות API), בראש הדף |
| מפתח API | api_key | Settings → API Keys |
| מזהה לקוח WhatsApp (WhatsApp Client ID) | whatsapp_client | העמודה Whatsapp Client ID בדף WhatsApp settings (הגדרות WhatsApp) |
לפני שמתחילים#
- כדי לראות, ליצור או למחוק מפתחות API, עליכם להיות Administrator (מנהל) בסביבת העבודה. ראו תפקידים והרשאות.
- בחרו קודם את סביבת העבודה הנכונה. מפתחות שייכים לסביבת העבודה שנבחרה בזמן יצירתם, ובקשות API שנשלחות עם מפתח פועלות על סביבת העבודה הזו. ראו החלפת סביבת עבודה.
- חשבונות הדגמה לא יכולים להשתמש ב-API.
איתור מזהה לקוח ה-API#
פתחו את Settings → API Keys. הכרטיס API Overview (סקירת API) מציג API Client ID: ואחריו מספר. השתמשו במספר הזה בשדה client_id בכל בקשה. הוא זהה לכל המפתחות בסביבת העבודה.
יצירת מפתח API#
פתחו את מפתחות ה-API
עברו אל Settings (הגדרות) ולחצו על הלשונית API Keys (מפתחות API), או פתחו ישירות את /settings/#api-keys.
צרו את המפתח
תחת New API Key (מפתח API חדש), לחצו על Create New (יצירת חדש). הודעת הצלחה מאשרת שהמפתח נוצר, והוא מופיע בטבלה.
העתיקו את המפתח המלא
העמודה API Key מציגה רק את ההתחלה והסוף של כל מפתח. לחצו על כפתור ההעתקה שלידו (Copy Full API Key, העתקת מפתח ה-API המלא) כדי להעתיק את המפתח המלא, ואז הדביקו אותו באפליקציה או באינטגרציה שלכם.
המפתחות מקבלים שמות אוטומטית לפי מספר המפתחות בסביבת העבודה (API Key 1, API Key 2 וכן הלאה) ואי אפשר לשנות את שמם. אחרי שמוחקים מפתח, מפתח חדש יכול לקבל שם זהה לשם של מפתח קיים, לכן הבחינו בין מפתחות לפי התווים הראשונים והאחרונים ולפי התאריך בעמודה Created (נוצר). המפתחות לא פגים: מפתח עובד עד שתמחקו אותו.
מגבלה#
לסביבת עבודה יכולים להיות עד 10 מפתחות API בו-זמנית. כשמגיעים למגבלה, מוצגת ההודעה "You have reached the maximum limit of 10 API keys per organization." מחקו מפתח שאתם כבר לא משתמשים בו כדי ליצור מפתח חדש.
טבלת מפתחות ה-API#
| עמודה | משמעות |
|---|---|
| Label (תווית) | שם המפתח, למשל API Key 1. |
| API Key | התווים הראשונים והאחרונים של המפתח. להעתקת המפתח המלא השתמשו בכפתור ההעתקה. |
| Created (נוצר) | התאריך שבו המפתח נוצר. |
| Status (סטטוס) | תמיד Active (פעיל). מפתחות שנמחקו מוסרים מהטבלה. |
| Actions (פעולות) | הכפתור Delete (מחיקה) מסיר את המפתח. |
מחיקת מפתח API#
מצאו את המפתח
בדף Settings → API Keys, מצאו את המפתח בטבלה.
מחקו אותו
לחצו על Delete, ואז על Yes, Delete API Key (כן, מחק את מפתח ה-API).
אי אפשר לבטל מחיקה של מפתח. כל אפליקציה שעדיין משתמשת בו מפסיקה לעבוד מיד ומקבלת Auth Error: invalid api key. עדכנו קודם את האפליקציות שלכם עם מפתח חדש.
מזהי לקוח WhatsApp#
לכל מספר WhatsApp מחובר יש מזהה משלו. רוב נקודות הקצה לשליחת הודעות צריכות אותו בשדה whatsapp_client כדי לבחור איזה מספר שולח את ההודעה.
פתחו את WhatsApp settings וקראו את העמודה Whatsapp Client ID שליד כל מספר. אם עדיין לא חיברתם מספר, ראו חיבור מספר ה-WhatsApp שלכם.
בדיקת פרטי הגישה#
קראו לבדיקת פרטי גישה (POST /api/v1/me/) עם client_id ו-api_key, ואם תרצו גם עם whatsapp_client. הקריאה מאשרת שהם עובדים יחד, בלי לשלוח דבר ובלי לצרוך הודעות. אם ה-whatsapp_client לא שייך לסביבת העבודה, התגובה היא Invalid WhatsApp Client ID.
אם מפתח API דלף#
כל מי שמחזיק במפתח ה-API ובמזהה לקוח ה-API שלכם יכול לשלוח הודעות ממספרי ה-WhatsApp שלכם ולצרוך את ההודעות של סביבת העבודה.
צרו מפתח חלופי
בדף Settings → API Keys, לחצו על Create New והעתיקו את המפתח החדש.
עדכנו את האפליקציות
החליפו את המפתח הישן בכל אפליקציה ואינטגרציה שהשתמשו בו.
מחקו את המפתח שדלף
לחצו על Delete במפתח שדלף. הוא מפסיק לעבוד מיד.
בדקו שימוש לרעה
עברו על ההודעות האחרונות בדף Reports (דוחות) וחפשו הודעות שלא אתם שלחתם.
התייחסו גם לאימייל "WbizTool Alert - WhatsApp Connected Successfully!" כאל מידע סודי: הוא נשלח ליוצר סביבת העבודה כשמספר מתחבר בפעם הראשונה, ועשוי לכלול את אחד ממפתחות ה-API שלכם.
פתרון בעיות#
| בעיה | מה לבדוק |
|---|---|
| הלשונית API Keys מציגה No API Keys Found (לא נמצאו מפתחות API), אבל קיימים מפתחות | אינכם Administrator בסביבת העבודה הזו, או שנבחרה סביבת עבודה אחרת. |
| "You don't have permission to create API keys in this space." | רק מנהלים יכולים ליצור או למחוק מפתחות. הכפתור Generate New API Key (יצירת מפתח API חדש) בטבלה ריקה מופיע לכולם, אבל עובד רק למנהלים. |
| "You have reached the maximum limit of 10 API keys per organization." | מחקו מפתח שאתם כבר לא משתמשים בו. |
ההודעה Auth Error: invalid api key | המפתח נמחק או הוקלד בטעות, או ש-client_id לא שייך לאותה סביבת עבודה כמו המפתח. אם גם מפתח חדש יחד עם ה-API Client ID שמוצג בדף נכשלים, פנו לתמיכה (בסביבות עבודה ותיקות יותר עשוי להופיע API Client ID שעובד רק עם מפתחות שיצר מי שיצר את סביבת העבודה). |
ההודעה Auth Error - Please send correct API key and Client id | השדה api_key חסר בבקשה. |
ההודעה Invalid client id. (או Invalid Client Id בחלק מנקודות הקצה) | השדה client_id חסר או שאינו מספר. בבדיקת פרטי גישה, client_id או api_key חסרים מחזירים רק Auth Error; שם, Invalid Client Id אומר שהערך אינו מספר. העתיקו אותו מהכרטיס API Overview. |
| הבקשות פועלות על סביבת העבודה הלא נכונה | המפתח נוצר בסביבת עבודה אחרת. החליפו סביבת עבודה וצרו בה מפתח. |
ההודעה Demo Account can not access apis | חשבונות הדגמה לא יכולים להשתמש ב-API. הירשמו לחשבון חינמי. |