نحن بصدد إنهاء API داخل المواقع. راجع مستند حالة إنهاء API داخل المواقع للحصول على التفاصيل، والتعرف على كيفية الترحيل إلى API السحابة من الجيل القادم.
تسجيل الخروج
/v1/users/logout
استخدم نقطة النهاية /v1/users/logout لتسجيل الخروج من عميل واجهة API واتساب للأعمال. تسجيل الخروج يلغي الرمز المميز للمصادقة.
قبل البدء
- تسجيل الخروج من عميل واجهة API واتساب للأعمال يلغي صراحة رمز المصادقة المرسل مع الطلب. وتظل أي رموز مميزة أخرى مرتبطة باسم المستخدم نفسه صالحة.
- إذا أردت تسجيل خروج أحد المستخدمين أو إلغاء الرمز المميز للمستخدم، فاستخدم نقطة النهاية DELETE /v1/users بدلاً من ذلك. هذا الإجراء يحذف المستخدم من النظام.
الإنشاء
يمكن للمستخدم إنشاء طلب تسجيل خروج عن طريق إجراء استدعاء POST لنقطة النهاية هذه.
مثال
POST /v1/users/logout Authorization: Bearer your-auth-token
تتضمن الاستجابة لطلب تسجيل الخروج كائن meta في النص الرئيسي للاستجابة.
| رمز استجابة HTTP | النتيجة |
|---|---|
| نجاح الأمر — تم التحقق من صحة الطلب وتم تسجيل خروج المستخدم من الحساب. |
| الخطأ — لم يتم التحقق من صحة الطلب ولم يتم تسجيل خروج المستخدم من الحساب. سيقدم رمز الخطأ والمعلومات الأسباب المحتملة لحدوث الخطأ، مثل بيانات اعتماد غير صالحة. |
الأخطاء
في حالة وجود أخطاء في الاستجابة، راجع المصادر التالية للحصول على مزيد من المعلومات: