#P1380
POST /api/auth/connect/branch
Route Info
| مورد | توضیح |
|---|---|
| Method | POST |
| Endpoint | /api/auth/connect/branch |
| Controller | App\Http\Controllers\Api\Panel\V2\UserController@connectBranch |
| Middleware فعال | None |
| Purpose (هدف) | دریافت کد شعبه از کاربر برای اتصال به دامنه اختصاصی مربوطه و بازگرداندن اطلاعات دامنهٔ فعال. |
| Category | Auth / Connection / Branch |
تحلیل عملکرد (Analysis)
- دریافت فیلد
branchاز درخواست (Body JSON). - محاسبهٔ مقدار کد داخلی:
𝑐 𝑜 𝑑 𝑒 = code= request->get(‘branch’) - 1000; - جستجو در جدول
officesبرای یافتن رکوردی باcode = $codeوstatus = 1. - در صورت وجود، نخستین مقدار JSON دیکد شده از فیلد
domainبازگردانده میشود. - در صورت عدم وجود رکورد معتبر، خروجی خطا با کد اختصاصی
1201برمیگردد.
ورودیها (Inputs)
| فیلد | نوع داده | اجباری | توضیح |
|---|---|---|---|
branch |
integer (JSON body) | ✅ | کد شعبهٔ ورودی (مثلاً 1050) که پس از کسر عدد 1000 شناسه واقعی در پایگاه داده خواهد بود. |
نمونه:
json
{
“branch”: 1050
}
خروجیها (Outputs)
json
{
“status”: true,
“data”: {
“domain”: “example.com”
}
}
در صورت خطا:
json
{
“status”: false,
“code”: 1201,
“message”: “کد دسترسی نا معتبر می باشد.”
}
وابستگیها (Dependencies)
| وابستگی | کاربرد |
|---|---|
DB (offices) |
جستجوی داده شعبه و دامنه |
Illuminate\Http\Request |
دریافت ورودی کاربر |
نمونهٔ تست و استفاده (Testing & Usage)
ریکوئست زیر برای تست در Postman قابل استفاده است:
bash
curl -X POST \
https://your-domain.com/api/auth/connect/branch \
-H “Content-Type: application/json” \
-d ‘{“branch”:1050}’
در پاسخ باید دامنهٔ معتبر شعبه بازگردد.
Typical Error Cases
| خطا | علت | کد HTTP |
|---|---|---|
invalid_branch_code |
ورود عددی خارج از محدوده یا عدم وجود رکورد با وضعیت فعال | 400 |
access_denied |
درخواست به دامنهٔ غیرمجاز یا شناسهٔ IP غیرقابلاعتماد (درصورت افزودن middleware در نسخههای بعد) | 403 |
نتیجه نهایی (Conclusion)
این endpoint برای اتصال اولیهٔ اپراتور یا سیستم خارجی به دامنهٔ صحیح سازمانی استفاده میشود و پایهٔ احراز هویت در مراحل بعدی (connectOtp، connectSubmit) است. عدم وجود وابستگی امنیتی (Middleware) نشانگر آن است که باید در لایهٔ شبکه یا Gateway کنترل شود.