POST /api/auth/connect/branch

Auth - Connect Branch API Documentation

Route Info

تحلیل عملکرد (Analysis)

این Endpoint یک نقطه ورود بدون احراز هویت (Unauthenticated) برای شناسایی و اعتبارسنجی شعبه است. هدف آن، بازگرداندن دامنه محیطی شعبه معتبر می‌باشد.

مکانیزم کدگذاری شعبه

سیستم از فرمول زیر برای استخراج شناسه واقعی شعبه از کد ارسالی استفاده می‌کند:

Actual Office ID = Input Branch Code - 1000

برای مثال اگر کد ورودی 1050 باشد، شناسه واقعی شعبه 50 خواهد بود.

منطق اعتبارسنجی

ورودی‌ها (Inputs)

Example Request Body:

{
  "branch": 1050
}

خروجی‌ها (Outputs)

پاسخ همیشه HTTP 200 بازمی‌گردد.

خروجی موفق:

{
  "status": true,
  "time": 1731324000,
  "data": {
    "domain": "example.com"
  }
}

خروجی ناموفق:

{
  "status": false,
  "code": 1201,
  "message": "کد دسترسی نا معتبر می باشد."
}

وابستگی‌ها (Dependencies)

تست و استفاده (Testing & Usage)

Example cURL:

curl -X POST https://yourdomain.com/api/auth/connect/branch \
  -H "Content-Type: application/json" \
  -d '{"branch":1050}'

موارد خطا (Typical Error Cases)

جزئیات پیاده‌سازی (Conceptual Implementation)

$branch = $request->get('branch');
$code = $branch - 1000;

$office = DB::table('offices')
    ->where('id', $code)
    ->where('status', 1)
    ->select('domain')
    ->first();

if ($office) {
    return response()->json([
        'status' => true,
        'time' => now()->timestamp,
        'data' => [ 'domain' => json_decode($office->domain)[0] ],
    ]);
}
return response()->json([
    'status' => false,
    'code'   => 1201,
    'message'=> 'کد دسترسی نا معتبر می باشد.'
]);

نتیجه نهایی (Conclusion)

این Endpoint بدون نیاز به توکن احراز هویت، دامنه شعبه را تعیین می‌کند. طراحی آن ساده و سریع بوده و پایهٔ احراز در سایر سرویس‌های connectOtp و connectSubmit می‌باشد.

پیوست: نگهداری و امنیت

Changelog