خروج از حساب کاربری (Logout)
برای خروج از حساب کاربری در سیستم استفاده می‌شود و توکن مرتبط با آن کاربر را منقضی می‌کند.
اطلاعات عمومی
- آدرس:
/api/v3/auth/logout - متد:
POST - نوع محتوا:
application/json - احراز هویت: نیازمند token
هدرهای مورد نیاز
| هدر | مقدار | توضیحات |
|---|---|---|
| Authorization | <token> | توکن احراز هویت کاربر |
نمونه درخواست
curl --location 'https://corporate.snapp.site/api/v3/auth/logout' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--request POST
پاسخ
این درخواست پاسخی در بدنه (body) ندارد. در صورت موفقیت، وضعیت (status code) درخواست معمولاً 200 OK یا 204 No Content خواهد بود.
خطاهای ممکن در API خروج از سیستم (Logout)
| کد وضعیت | توضیحات |
|---|---|
400 | درخواست نامعتبر (Bad Request) |
401 | احراز هویت ناموفق (Unauthorized) |
406 | فرمت درخواست قابل قبول نیست (Not Acceptable) |
429 | تعداد درخواست‌های بیش از حد (Too Many Requests) |
500 | خطای داخلی سرور (Internal Server Error) |
توضیحات تکمیلی
- این API برای خروج از سیستم استفاده می‌شود و توکن احراز هویت را بی‌اعتبار می‌کند.
- پس از خروج، درخواست‌های جدیدی که از همان توکن استفاده کنند، نامعتبر خواهند بود.