کاربر مهمان - REST

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

نکته: در صورتی که با مفهوم REST و سرویس‌های سمت سرور و یا با دستور curl آشنایی ندارید، به آشنایی با REST مراجعه کنید.

پیش‌نیازها

  1. در صورتی که با سرویس کاربران آشنایی ندارید، به معرفی سرویس کاربران مراجعه کنید.
  2. اگر با فرآیند امنیتی ورود کاربران در بکتوری آشنایی ندارید، به فرآیند امنیتی بکتوری مراجعه کنید.

ثبت نام مهمان (register-guest)

با استفاده از این سرویس، شما می‌توانید شرایطی را فراهم کنید که کاربران بدون نیاز به وارد کردن اطلاعات خود، وارد سیستم می‌شوند. این نوع کاربران به عنوان مهمان در سیستم ذخیره می‌شوند و شما می‌توانید محدودیت‌هایی را برای آن‌ها در نظر بگیرید. پس از ثبت نامِ این نوع کاربران، کاربری با نام کاربری و کلمه عبور تصادفی ساخته می‌شود و مقادیر نام کاربری و کلمه عبور آن برگردانده می‌شود. شما می‌توانید در زمان دلخواه اطلاعات این کاربران را در سیستم وارد نمایید تا به کاربران عادی تبدیل شوند. لازم به ذکر است، تاریخچه فعالیت آن‌ها در سیستم نگه داشته خواهد شد (در ادامه سرویس‌های مربوط توضیح داده می‌شوند).

توجه: در header این درخواست نیاز به X-Backtory-Authentication-Id وجود دارد که با مراجعه به پنل بکتوری، در قسمت کلیدها قابل مشاهده می‌باشد.

curl -X POST \
    --header "X-Backtory-Authentication-Id: <ID>" \
    --header "Content-Type: application/json" \
    -d '{}' \
    https://api.backtory.com/auth/guest-users

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

Tables Description
200-OK Successful
404-Not Found Your Authentication-Id is wrong
500-Internal Server Error Data access was unsuccessful
503-Service Unavailable Your service is disabled

نمونه‌ای از پاسخ دریافت شده از این سرویس عبارت است از:

{
  "id": "574d8dd5e4b0f6894e1472c7",
  "username": "Uunppq9gerou8v6d",
  "password": "Pa1hsp8jc7ergb51"
}

به کمک نام کاربری و رمز عبوری که دریافت کرده‌اید، می‌توانید مانند یک کاربر عادی ورود کنید.

تکمیل ثبت نام مهمان (complete-registration)

با استفاده از این سرویس می‌توانید اطلاعات کاربران مهمان را در سیستم وارد نمایید و بدین ترتیب به کاربران اصلی سیستم تبدیل کنید. لازم به ذکر است تاریخچه فعالیت کاربران مهمان در صورت تبدیل به کاربر اصلی حفظ خواهد شد.

توجه: در header این درخواست نیاز به X-Backtory-Authentication-Id وجود دارد که با مراجعه به پنل بکتوری، در قسمت کلیدها قابل مشاهده می‌باشد.

curl -X POST \
    --header "Content-Type: application/json"   \
    --header "X-Backtory-Authentication-Id: <ID>"   \
    --header "Authorization: Bearer <USER-ACCESS-TOKEN>" \
    -d '{
        "userId": "USER-ID",
        "firstName":"NEW-FIRSTNAME",
        "lastName":"NEW-LASTNAME",
        "newUsername":"NEW-USERNAME",
        "newPassword":"NEW-PASSWORD",
        "email":"aaa@bbb.ccc",
        "phoneNumber":"1234"
    }' https://api.backtory.com/auth/guest-users/complete-registration

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

Tables Description
200-OK Successful
403-Forbidden You are changing another user
404-Not Found Your Authentication-Id is wrong
500-Internal Server Error Data access was unsuccessful
503-Service Unavailable Your service is disabled

نمونه‌ای از پاسخ دریافت شده از این سرویس عبارت است از:

{
  "instanceId": "AUTHENTICATION-ID",
  "userId": "USER-ID",
  "username": "NEW-USERNAME",
  "firstName": "NEW-FIRSTNAME",
  "lastName": "NEW-LASTNAME",
  "email": "aaa@bbb.ccc",
  "phoneNumber": "1234",
  "guest": false,
  "active": true
}

گام بعدی