المستخدمون

/v1/users

استخدم العقدة users لإدارة المصادقة والوصول إلى عميل واجهة API داخل المواقع الخاصة بتطبيق واتساب للأعمال.

قبل البدء

يتوفر لدى عميل واجهة API داخل المواقع الخاصة بتطبيق واتساب للأعمال حساب بشكل افتراضي، مع تعيين admin كاسم المستخدم وكلمة المرور secret. ولا يمكن إزالة هذا الحساب أو حذفه من النظام. لأسباب تتعلق بالأمان، يجب تغيير كلمة سر حساب المسؤول على الفور.

إذا نسيت كلمة السر، فيُرجى الاتصال بالدعم المباشر للمساعدة على إعادة تعيينها.

التقييدات

• يمكن لحساب admin فقط إنشاء المستخدمين أو حذفهم.

التوصيات

• استخدم حساب admin فقط لإنشاء المستخدمين أو حذفهم
• إنشاء حسابات مستخدمين لإدارة عملاء API الخاصة بتطبيق واتساب للأعمال داخل المواقع

الإنشاء

لإنشاء حساب لأحد المستخدمين داخل نشاطك التجاري بحيث يمكنه الوصول إلى واجهة API الخاصة بتطبيق واتساب للأعمال، أرسل اسم المستخدم وكلمة السر إلى عميل واجهة API داخل المواقع الخاصة بتطبيق واتساب للأعمال باستخدام نقطة النهاية /users. حيث يتحقق من اسم المستخدم وكلمة السر وينشئ حسابًا جديدًا إذا لم يكن هناك حساب بالفعل لاسم المستخدم هذا. وتتم معالجة كلمة السر بعلامة تجزئة أحادية الاتجاه وتخزينها في حجم البيانات. علمًا بأن المعلمتين username وpassword مطلوبتان.

مثال

لإنشاء مستخدم، أرسل طلبًا على النحو التالي:

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

إذا نجح الطلب وتم إنشاء حساب المستخدم، فستتلقى رمز حالة HTTP بالقيمة 201 Created وحمولة البيانات التالية:

{
  "users": [{
     "username": "username"
  }]
}

أما إذا لم ينجح الطلب، فستتلقى رمز حالة HTTP، بالإضافة إلى رمز خطأ في واتساب. إذا أرسلت اسم مستخدم مكررًا، فستبدو الاستجابة كما يلي:

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

المعلمات

عناصر الربط

ترتبط عناصر الربط التالية بهذه العقدة:

الأخطاء الشائعة

إذا لم تكن هناك أخطاء أخرى في الاستجابة، فارجع إلى المصادر التالية لمزيد من المعلومات: رموز الأخطاء ورموز حالات HTTP.