TIP
מסמך זה תורגם על ידי בינה מלאכותית. לכל אי דיוק, אנא עיין בגרסה האנגלית
סנכרון נתוני משתמשים באמצעות HTTP API
קבלת מפתח API
עיינו ב-מפתחות API. ודאו שלתפקיד המשויך למפתח ה-API יש את ההרשאות הנדרשות לסנכרון נתוני משתמשים.
סקירת API
דוגמה
נקודת קצה (Endpoint)
פורמט נתוני משתמשים
UserData
| פרמטר | סוג | תיאור |
|---|---|---|
dataType | 'user' | 'department' | חובה. סוג הנתונים הנשלחים. השתמשו ב-user לשליחת נתוני משתמשים. |
matchKey | 'username' | 'email' | 'phone' | אופציונלי. משמש להתאמת משתמשי מערכת קיימים בהתבסס על השדה שצוין. |
records | UserRecord[] | חובה. מערך של רשומות נתוני משתמשים. |
UserRecord
| פרמטר | סוג | תיאור |
|---|---|---|
uid | string | חובה. מזהה ייחודי לנתוני המשתמש המקוריים, המשמש לקישור נתוני המקור למשתמש המערכת. בלתי ניתן לשינוי עבור משתמש. |
nickname | string | אופציונלי. כינוי המשתמש. |
username | string | אופציונלי. שם המשתמש. |
email | string | אופציונלי. כתובת האימייל של המשתמש. |
phone | string | אופציונלי. מספר הטלפון של המשתמש. |
departments | string[] | אופציונלי. מערך של מזהי UID של מחלקות שהמשתמש משויך אליהן. |
isDeleted | boolean | אופציונלי. מציין אם הרשומה נמחקה. |
<field> | any | אופציונלי. שדות מותאמים אישית בטבלת המשתמשים. |
פורמט נתוני מחלקות
INFO
שליחת נתוני מחלקות דורשת שהתוסף מחלקות יהיה מותקן ומופעל.
DepartmentData
| פרמטר | סוג | תיאור |
|---|---|---|
dataType | 'user' | 'department' | חובה. סוג הנתונים הנשלחים. השתמשו ב-department עבור נתוני מחלקות. |
records | DepartmentRecord[] | חובה. מערך של רשומות נתוני מחלקות. |
DepartmentRecord
| פרמטר | סוג | תיאור |
|---|---|---|
uid | string | חובה. מזהה ייחודי לנתוני המחלקה המקוריים, המשמש לקישור נתוני המקור למחלקת המערכת. בלתי ניתן לשינוי. |
title | string | חובה. כותרת המחלקה. |
parentUid | string | אופציונלי. UID של מחלקת האב. |
isDeleted | boolean | אופציונלי. מציין אם הרשומה נמחקה. |
<field> | any | אופציונלי. שדות מותאמים אישית בטבלת המחלקות. |
INFO
- שליחת נתונים היא פעולה אידמפוטנטית.
- אם מחלקת אב אינה קיימת בעת שליחת נתוני מחלקות, לא ניתן ליצור את הקישור. תוכלו לשלוח את הנתונים שוב לאחר שמחלקת האב נוצרה.
- אם מחלקתו של משתמש אינה קיימת בעת שליחת נתוני משתמשים, לא ניתן לשייך את המשתמש לאותה מחלקה. תוכלו לשלוח את נתוני המשתמשים שוב לאחר שנתוני המחלקות נשלחו.