SingleSignOn CreateToken

این وب‌سرویس برای شروع فرآیند Single Sign-On (SSO) و دریافت Token احراز هویت کاربر استفاده می‌شود.

برای شروع فرآیند، کاربر را با استفاده از متد GET به Endpoint این وب‌سرویس هدایت کنید.

پس از ورود کاربر به صفحه ورود سپهر:

صفحه لاگین سپهر به کاربر نمایش داده می‌شود.
کاربر نام کاربری و رمز عبور خود را وارد می‌کند.
در صورت موفقیت‌آمیز بودن احراز هویت، یک Token برای کاربر ایجاد می‌شود.
کاربر به آدرس callbackUrl که در درخواست مشخص کرده‌اید بازگردانده می‌شود.
Token ایجادشده با استفاده از متد POST به callbackUrl ارسال می‌شود.

دریافت Token به‌تنهایی به معنی معتبر بودن آن نیست. پس از دریافت Token، برای بررسی صحت و اعتبار آن باید وب‌سرویس VerifyToken را فراخوانی کنید.

آدرس callbackUrl باید پیش از استفاده در سیستم رزرواسیون سپهر ثبت و Trusted شده باشد.

برای ثبت و Trust کردن callbackUrl، لطفاً با تیم پشتیبانی سپهر تماس بگیرید.

API Endpoint

GET https://{SupplierWebsiteUrl}/api/IAM/Bot/SingleSignOn/CreateToken/V1?culture={Culture}&callbackUrl={YourCallBackUrl}

Request Parameters

`culture`

string [Required]

زبان صفحه ورود سپهر را مشخص می‌کند.

مقادیر قابل قبول:

fa-IR — فارسی
en-US — انگلیسی
ar-IQ — عربی

callbackUrl

string [Required]

آدرس URL سایت شما است که پس از احراز هویت موفق کاربر، کاربر به آن بازگردانده می‌شود.

پس از بازگشت کاربر به این آدرس، Token ایجادشده نیز با استفاده از متد POST به همین آدرس ارسال خواهد شد.

Sample Request

نمونه Url برای هدایت کاربر

https://SepehrApiTest.ir/api/IAM/Bot/SingleSignOn/CreateToken/V1?culture=fa-IR&callbackUrl=https://YourDomain.ir/IAM/Sepehr/LoginCallback

Callback

پس از احراز هویت موفق کاربر، سپهر کاربر را به callbackUrl مشخص‌شده در درخواست بازمی‌گرداند.

در این مرحله، Token تولیدشده با استفاده از متد POST برای callbackUrl ارسال می‌شود.

Sample Callback Data

{
  "Token": "1tyGPflYdMFQSrwmgwBFLevxrmsehYhqnlTIVER2"
}

Response Data

Token

string

توکن احراز هویت ایجادشده پس از ورود موفق کاربر به سیستم سپهر است.

این مقدار در زمان بازگشت کاربر به callbackUrl، با استفاده از متد POST برای آدرس Callback ارسال می‌شود.

Authentication Flow

فرآیند احراز هویت به صورت زیر انجام می‌شود:

Your Website
     │
     │  GET CreateToken
     ▼
Sepehr SSO
     │
     │  Login
     ▼
User Authentication
     │
     │  Success
     ▼
Generate Token
     │
     │  Redirect User
     ▼
Your callbackUrl
     │
     │  POST { Token }
     ▼
Your Website
     │
     │  VerifyToken
     ▼
Token Validation
     │
     ▼
Authenticated User

خلاصه فرآیند

کاربر را به Endpoint CreateToken هدایت کنید.
کاربر در صفحه ورود سپهر احراز هویت می‌شود.
سپهر یک Token ایجاد می‌کند.
کاربر به callbackUrl بازگردانده می‌شود.
Token از طریق POST به callbackUrl ارسال می‌شود.
سایت شما Token را دریافت می‌کند.
برای اعتبارسنجی Token، وب‌سرویس VerifyToken را فراخوانی کنید.
در صورت معتبر بودن Token، کاربر احراز هویت‌شده است و می‌توانید از سایر Bot APIها استفاده کنید.

لیست سرویس‌ها