Bulk user management API

‫Bulk User Management API מאפשר לכם להשתמש בתוכן של קובץ JSON כדי ליצור או לשנות כמה משתמשים בפעולה אחת.

אין הגבלה על מספר הרשומות שאפשר להעלות, אבל מומלץ לבצע את הבקשות בקבוצות קטנות יותר.

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

אפליקציית ההפניה Bulk User Sync Tool מסופקת כדי לבצע סנכרון של משתמשים בין ספרייה כמו קבוצות Google Workspace או Microsoft Entra ID לבין CCaaS. אפליקציית ההפניה הזו מבוססת על Bulk user management API.

תפקידים והרשאות

  • כדי להשתמש ב-Apps API, צריך ליצור api_user.

  • למשתמש api_user אין תפקידים והרשאות, ולכן כל משתמשי api_user יכולים לבצע את הפעולה bulk_user management.

  • אי אפשר להגדיר הרשאות גרנולריות כשמשתמשים ב-api_user, ולכן ל-api_user תהיה גישה לכל שדות המשתמש.

הוספת פרטי כניסה ל-API

  1. בפורטל של פלטפורמת CCAI, עוברים אל הגדרות > הגדרות למפתחים > ניהול פרטי כניסה ל-API.

  2. לוחצים על + הוספת פרטי כניסה ל-API. תיפתח ההודעה Add API Credential (הוספת פרטי כניסה ל-API).

  3. מזינים שם לפרטי הכניסה.

  4. לוחצים על יצירה.

שימוש ב-API לניהול משתמשים בכמות גדולה

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

  1. אופציונלי: שליפת תבנית ה-JSON. הפעולה הזו מאחזרת את התבנית העדכנית ביותר, שכוללת את כל התפקידים או הצוותים הנוספים שנוצרו מאז שאחזרתם את התבנית הקודמת. ‫Google ממליצה לבצע את השלב הזה.

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

  3. מעלים את קובץ ה-JSON. אפשר להוסיף או לעדכן משתמש אחד או כמה משתמשים בקובץ. חשוב לשים לב למזהה המשרה.

  4. שליחת בקשה לעיבוד קובץ ה-JSON. הפעולה הזו תתחיל את העדכון בכמות גדולה.

  5. אופציונלי: בדיקת סטטוס. צריך לציין את מזהה המשימה כדי לבדוק את סטטוס העיבוד.

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

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

  8. אופציונלי: אחזור שגיאות. לקבל שגיאות.

העלאת קובץ ה-JSON

Usage

העלאת קובץ ה-JSON

כתובת URL

apps/api/v1/bulk/users/upload

‏Method

POST / PUT

בקשה

content-type: multipart/form-data

{
  "id" : {job_id} #optional. Required in case of PUT method.
  "file": {json file}
}

תשובה

כותרת:

Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345

גוף

{
  "id": 12345, # job_id
  "status": "created"
  "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"
}

אחזור תבנית JSON

Usage

תבנית

כתובת URL

apps/api/v1/bulk/users/template

‏Method

GET

בקשה

(ריק)

תשובה

 
[
{
"email":"user1@yourcompany.co",
"new_email":user1@yourcompany.cx",
"agent_number":"A-001",
"first_name":"John",
"last_name":"aa",
"status":"Active",
"location":"Mexico",
"max_chat_limit":2,
"max_chat_limit_enabled":0,
"roles": [
{"name":"Admin","value": 0 },
{"name":"Manager","value": 1 },
{"name":"Agent","value": 0 },
{"name":Developer","value": 1 }
]
},
 ...
]

השבתת משתמש

כדי להשבית משתמש, משנים את הערך של status ל-Inactive. לדוגמה: "status":"Inactive".

עיבוד הבקשה של קובץ ה-JSON הנוכחי

Usage

בקשה לעיבוד של קובץ ה-JSON הנוכחי

כתובת URL

/v1/bulk/users/proceed

‏Method

POST

בקשה

 
{
   "id": 12345  # job_id
}

תשובה

כותרת:

Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345

גוף

1{"id": 12345 # job_id3 "status": "valid_scheme",4 "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"5}

בדיקת הסטטוס

Usage

בדיקת הסטטוס

כתובת URL

apps/api/v1/bulk/users/jobs/#{job_id}

‏Method

GET

בקשה

משתנה נתיב – job_id

תשובה

 
{
    "id": 12345,
    "created_at": "2022-01-07T06:40:34.000Z",
    "process_requested_at": "2022-01-07T06:45:34.000Z",
    "filename": "100row.json",
    "total_rows": 100,
    "affected_rows": 52,
    "failed_rows": 0,
    "status": "in_progress",
    "uploaded_user_name": null,
    "proceed_user_name": null,
    "uploaded_api_user_name": "api_user_name_1",
    "proceed_api_user_name": "api_user_name_2",
    "scheme_errors": []
    "update_errors": []
}

שליפת רשימת משרות מעודכנת

Usage

קבלת רשימת משרות מעודכנת

כתובת URL

apps/api/v1/bulk/users/jobs

‏Method

GET

בקשה

 
{
  "page": 1,
  "per_page": 20
}

תשובה

כותרת

Link: <next link>
Total: 12345
Per-Page: 201

גוף

[
    {
        "id": 12345,
        "created_at": "2022-01-07T06:21:10.000Z",
        "process_requested_at": "2022-01-07T06:22:25.000Z",
        "filename": "100row.json",
        "total_rows": 100,
        "affected_rows": 52,
        "failed_rows": 0,
        "status": "in_progress",
        "uploaded_user_name": null,
        "proceed_user_name": null,
        "uploaded_api_user_name": "api_user_name_1",
        "proceed_api_user_name": "api_user_name_2",
        "scheme_errors": [],
        "update_errors": []
    },
    ...
]

נתונים

הפלט ממוין בסדר הפוך של job_id, כך שהנתונים העדכניים ביותר מופיעים ראשונים.

אחזור יומני שגיאות של סכימות

Usage

קבלת יומני שגיאות של סכימה

כתובת URL

/v1/bulk/users/errors/scheme/#{job_id}

‏Method

GET

בקשה

משתנה נתיב – job_id

תשובה

content-type: application/json

[
  {
    "message": "Must be a valid email",
    "column": 1,
    "row": null
  },
  {
    "message": "Non-empty string",
    "column": 10,
    "row": 10
  }
]

אחזור שגיאות

Usage

קבלת יומני שגיאות של עדכונים

כתובת URL

/v1/bulk/users/errors/update/#{job_id}

‏Method

GET

בקשה

משתנה נתיב – job_id

תשובה

content-type: application/json

1[2 {3 "message": "Must be a valid email",4 "column": 1,5 "row": null,6 "error_type": "warning"7 },8 {9 "message": "Non-empty string",10 "column": 10,11 "row": 10,12 "error_type": "error"13 } 14]