توثيق نقاط نهاية المصادقة

يشرح هذا الدليل كيفية المصادقة مع واجهتنا البرمجية باستخدام رموز الوصول.

١. مقدمة

يسجّل العملاء الدخول ببيانات اعتماد صحيحة للحصول على رمز وصول يُستخدم في الطلبات اللاحقة.

٢. نقاط نهاية المصادقة

٢٫١. /auth/login

• الطريقة: POST

• الوصف: تسجيل الدخول للحصول على رمز وصول.

• المعاملات:

  • username: اسم المستخدم.

  • password: كلمة المرور.

مثال على الطلب:

curl -X POST "https://api.example.com/auth/login" -d "username=user@example.com" -d "password=secret"

مثال على الاستجابة:

{ "access_token": "eyJhbGciOi...", "token_type": "bearer" }

٣. طرق الطلب

يستخدم تسجيل الدخول طريقة POST.

٤. معاملات الطلب

• لنقطة /auth/login:

  • username: اسم المستخدم أو البريد الإلكتروني.

  • password: كلمة المرور.

٥. صيغة الاستجابة

JSON يتضمن رمز الوصول ونوعه.

٦. معالجة الأخطاء

تُعاد الأخطاء مع رمز حالة HTTP ورسالة توضيحية.

٧. نماذج الطلبات والاستجابات

راجع الأمثلة أعلاه.

٨. موارد إضافية

• إدارة الموافقة

• مرجع API

هذا كل شيء! تواصل مع فريق الدعم إن احتجت إلى مساعدة.