تسجيل الدخول

/v1/users/login

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

قبل البدء

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

توصيات كلمة السر

نوصي باستخدام كلمات سر قوية عند إنشاء حسابات جديدة وعند تعيين كلمات سر جديدة للحسابات حسب أفضل الممارسات في المجال.

ويجب أن يتراوح طول كلمات السر بين 8 و64 حرفًا وتتضمن على الأقل ما يلي:

  • رقم واحد
  • حرف واحد كبير
  • حرف واحد صغير
  • حرف خاص واحد من الأحرف التالية !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

يُفرض تعقيد كلمة السر عند إنشاء حساب جديد أو تغيير كلمة السر الحالية للحساب.

الإنشاء

يمكنك المصادقة باستخدام المصادقة الأساسية (اسم المستخدم، كلمة السر) عند تسجيل الدخول. ويتم تعيين Authorization في عنوان HTTP. كما يتم تعيين type إلى Basic وتكون credentials عبارة عن سلسلة بتشفير base64 تتكون من username وpassword مفصولة بنقطتين (مثل username:password).

عندما يتلقى عميل API الخاصة بواتساب للأعمال طلب تسجيل الدخول، تتم معالجة بيانات الاعتماد بغرض التحقق.

  • وإذا نجح الأمر، يتم إنشاء الرمز المميز الخاص بك. وتحتوي الاستجابة على الرمز في الحقل token.
  • وإذا لم ينجح الأمر، يتم إرجاع رسالة خطأ.

أمثلة

تسجيل الدخول لأول مرة

لأغراض تتعلق بالأمان، يتعين عليك تحديث كلمة السر الافتراضية لحساب المسؤول لإنشاء كلمة سر جديدة باستخدام الحقل new_password في المرة الأولى التي تحاول فيها تسجيل الدخول. وإذا كنت تحاول تسجيل الدخول باستخدام كلمة السر الافتراضية ولا توجد معلومات في الحقل new_password، فسيُرجع النظام رسالة خطأ.

راجع كلمات السر لمعرفة التوصيات. يجب أن يبدو تسجيل الدخول الأول كما يلي:

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

يكون إصدار cURL على النحو التالي:

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

تسجيل الدخول القياسي

يبدو تسجيل الدخول القياسي لعميل API الخاصة بواتساب للأعمال هكذا:

POST /v1/users/login
Authorization: Basic base64(username:password)

يكون إصدار cURL على النحو التالي:

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

عند نجاح العملية، يتم إرجاع حالة 200 OK جنبًا إلى جنب مع الرمز ووقت انتهاء صلاحية الرمز. علمًا بأنه تنتهي صلاحية جميع الرموز التي تم إنشاؤها خلال 7 أيام. تبدو الاستجابة كما هو موضح في المثال التالي:

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

إذا لم ينجح الطلب، فستظهر لك حالة HTTP 401 Unauthorized. ويعني ذلك بشكل عام أن اسم المستخدم و/أو كلمة السر التي تم إرسالها مع طلب تسجيل الدخول غير صالحة، وبالتالي يتعذر على عميل API الخاصة بواتساب للأعمال إنشاء الرمز.

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

الحقول التي تم إرجاعها

الحقل الوصف

token

مطلوب.

يمثل رمز المصادقة المطلوب استخدامه في جميع الاستدعاءات الأخرى لواجهة API الخاصة بواتساب للأعمال. ويجب إرسال الرمز في عنوان التصريح بالتنسيق التالي:
Authorization: Bearer <authentication-token>

expires_after

مطلوب.

يمثل الطابع الزمني لانتهاء صلاحية الرمز. ويتم تعيينه بشكل افتراضي على 7 أيام.