ברוכים הבאים לפורטל המפתחים של SmartSense! SmartSense היא מערכת ניטור באמצעות חיישנים מרחוק, המספקת פתרונות המסייעים לחברות בתחומי בקרת איכות, תפוקת עובדים, הגנה על נכסים ועמידה בדרישות הרגולטוריות. בפורטל המפתחים תוכלו למצוא מידע על ממשקי ה-API (ממשקי תכנות יישומים) שאנו מציעים, וכן על אופן השימוש בהם.
​

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

שיטות אימות/הרשאה

סוגים גלובליים

טיפול בשגיאות

API של נתונים

API של דוח

ממשק ה-API של SCIM גרסה 2

יש להשתמש בממשק ה-API הזה באחריות, ובהתאם לנהלים המומלצים ולהנחיות שנקבעו על ידי SmartSense.
​
​

שימוש אחראי:

שימוש לא אחראי:

על ידי הקפדה על הנחיות SmartSense, המפתחים מבטיחים שה-API יישאר יציב ויעיל עבור כולם.

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

SmartSense שומרת לעצמה את הזכות להחזיר שדות נוספים בתשובות.

הגבלת הקצב מוגדרת לכל חשבון בנפרד. לא כל הבקשות כפופות להגבלת קצב; ההגבלות מוחלות בהתאם להגדרות החשבון שלך.
​

פרטי מגבלת הקצב

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

לדוגמה, ניתן להגדיר חשבון עם מגבלה של 1,000 בקשות ב-60 שניות.

כותרות הגבלת קצב

כאשר הגבלת קצב מופעלת בחשבון שלך, תגובות ה-API כוללות את הכותרות הבאות:

התמודדות עם מגבלות קצב

אם תחרוג ממגבלת הקצב שלך, ה-API יחזיר קוד סטטוס HTTP 429 (Too Many Requests) יחד עם Retry-After כותרת המציינת מתי ניתן לנסות שוב את הבקשה.

1. על היישום שלכם: לפקח על ה- ratelimit-remaining כותרת למעקב אחר בקשות זמינות

2. לכבד את Retry-After ערך הכותרת בעת קבלת תגובה 429

3. השתמש ב- איפוס מגבלת התעבורה חשוב להבין מתי ייעודכן המגבלה שלך

4. ליישם השהיה אקספוננציאלית כאשר מתרחשות שגיאות במגבלת הקצב

5. יש לאחסן בתא המטמון את תגובות ה-API כאשר הדבר מתאים, כדי לצמצם בקשות מיותרות

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

מניעה: יש ליישם אסטרטגיות "back-off" ולעקוב אחר כותרות מגבלת הקצב כדי לנהל את תדירות הבקשות ביעילות.

הגבלות והגבלות

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

מכסות לשימוש במשאבים

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

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

מדיניות שמירת נתונים

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

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

ניהול גירסאות API

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

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

תלות בתדירות הדיווח של המכשיר

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

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