إضافة الوكيل

توضح هذه المقالة كيفية إدارة الوكلاء عبر API زيتون، بما في ذلك عرض بيانات الوكيل وإنشاء حقول مخصصة له، تعديل إعداداته وصلاحياته أو حذفه واستعادته، وذلك باستخدام أمثلة عملية مبسطة.

عرض وكيل

لعرض البيانات الشخصية للوكيل رقم 1008، نكتب الطلب على النحو التالي:

curl "https://example.com/api/agent/v1/agents/1008" \
   -H 'Authorization: Bearer $TOKEN'

حقول مخصصة للوكلاء

لإنشاء مجموعة حقول مخصصة جديدة خاصة بالوكلاء تتضمن حقل العنوان ليكون حقل نصي غير مطلوب، وحقل العمر وهو قائمة خيارات لتحديد الفئة العمرية للوكيل وهو حقل مطلوب نكتب الطلب على النحو التالي:

curl "https://example.com/api/agent/v1/custom-fields" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "مجموعة الحقول الجديدة",
    "sort": 0,
    "resource": "agent",
    "fields": [
      {
        "label": "العنوان",
        "placeholder": "اكتب عنوانك التفصيلي هنا",
        "hint": "اذكر اسم الدولة والمدينة",
        "type": "text",
        "sort": 0,
        "grid": "100",
        "required": false,
        "status": "active"
      },
      {
        "label": "العمر",
        "placeholder": "اختر فئتك العمرية من القائمة",
        "hint": "قائمة بالفئات العمرية",
        "type": "select",
        "sort": 1,
        "grid": "50",
        "required": true,
        "status": "active",
        "options": [
          {"value": "18-25"},
          {"value": "26-45"},
          {"value": "> 45"}
        ]
      }
    ],
    "display": "tab",
    "team_ids": [1009],
    "agent_ids": [1008, 108]
  }'

تعديل وكيل

لتعديل بعض بيانات الوكيل رقم 1008 بتعديل صناديق البريد التي يمكنه العمل عليها لتكون الصناديق رقم 110 و 1010، ومنحه صلاحية الوصول لمجموعة حقول مخصصة رقمها التعريفي 1016، سنكتب الطلب التالي:

curl "https://example.com/api/agent/v1/agents/1008" \
   -X PUT \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $TOKEN" \
   -d '{
         "first_name": "Saleh",
         "last_name": "Amin",
         "email": "agent@exampel.com",
         "status": "active",
         "inbox_ids": [110, 1010],
         "field_group_ids": [1016]
    }'

يجب الانتباه إلى أن أي صناديق بريد لا تُمرر أرقامها ضمن المصفوفة inbox_ids، فلن يعود للوكيل صلاحية عليها، وينطبق الأمر نفسه على فرق العمل، والنماذج، والحقول المخصصة، وأي مصفوفات أخرى تخص الوكيل.

حذف وكيل

على سبيل المثال يحذف الطلب التالي الوكيل رقم 1008 من مركز المساعدة:

curl "https://example.com/api/agent/v1/agents/1008" \
   -X DELETE \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $TOKEN"

ولاستعادته نُرسل الطلب التالي:

curl "https://example.com/api/agent/v1/agents/1008/restore" \
   -X POST \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $TOKEN"

إقرأ أيضاً

• إضافة فريق العمل
• الإتصال بالواجهة البرمجية