مهاجرت کاربر و مدیریت دسترسی

در رابط برنامه‌نویسی کاربردی محتوا برای خرید، شما کاربران و حقوق دسترسی آنها را با یک فیلد در منبع Account مدیریت می‌کردید. رابط برنامه‌نویسی کاربردی فروشنده این را با منبع اختصاصی به نام User و متدهای مربوطه (ایجاد، حذف، دریافت، فهرست، مسیر) جایگزین می‌کند. برای اطلاعات بیشتر، به بخش کنترل دسترسی به حساب خود مراجعه کنید.

تفاوت‌های کلیدی

در مقایسه با API محتوا برای خرید، API فروشنده مزایای زیر را برای مدیریت کاربر ارائه می‌دهد:

  • منبع اختصاصی : این یک روش دقیق‌تر و مستقیم‌تر برای کنترل اینکه چه کسی می‌تواند به حساب مرکز فروشندگان شما دسترسی داشته باشد و چه کاری می‌تواند انجام دهد، فراهم می‌کند.
  • نام‌های منابع RESTful : در رابط برنامه‌نویسی کاربردی فروشنده، منابع User را با نام کامل منبع شناسایی کنید، برای مثال، accounts/12345/users/example@example.com .
  • نام مستعار me : می‌توانید از نام مستعار me به جای آدرس ایمیل در نام منبع برای اشاره به کاربر احراز هویت شده استفاده کنید، برای مثال، accounts/12345/users/me .
  • حقوق دسترسی تجمیع‌شده : رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) فیلدهای دسترسی بولی (boolean) را از رابط برنامه‌نویسی کاربردی محتوا (Content API) (برای مثال، admin ، reportingManager ) در یک فیلد access_rights واحد و تکرارپذیر تجمیع می‌کند.
  • دعوت و تأیید کاربر : API فروشگاه، وضعیت کاربر را به صورت صریح ( PENDING یا VERIFIED ) معرفی می‌کند. وقتی کاربر جدیدی ایجاد می‌کنید، تا زمانی که دعوت را بپذیرد، در وضعیت PENDING قرار دارد. این قابلیت، امکان مشاهده وضعیت کاربر را برای API فراهم می‌کند، قابلیتی که در API محتوا برای خرید در دسترس نبود. درخواست‌های ## را اضافه کنید

رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) از آدرس‌های اینترنتی درخواست زیر برای مدیریت کاربران استفاده می‌کند:

  • GET /accounts/v1/accounts/{account}/users/{email}
  • GET /accounts/v1/accounts/{account}/users
  • POST /accounts/v1/accounts/{account}/users
  • PATCH /accounts/v1/accounts/{account}/users/{email}
  • DELETE /accounts/v1/accounts/{account}/users/{email}

جدول زیر URLهای درخواست را بین API محتوا برای خرید و API فروشنده مقایسه می‌کند.

درخواست توضیحات API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده
دریافت کاربران برای یک حساب کاربری GET {api_version}/{merchantId}/accounts/{accountId} GET {api_version}/accounts/{account}/users
ایجاد یک کاربر PATCH {api_version}/{merchantId}/accounts/{accountId} POST {api_version}/accounts/{account}/users
به‌روزرسانی یک کاربر PATCH {api_version}/{merchantId}/accounts/{accountId} PATCH {api_version}/accounts/{account}/users/{email}
حذف یک کاربر PATCH {api_version}/{merchantId}/accounts/{accountId} DELETE {api_version}/accounts/{account}/users/{email}

شناسه‌ها

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

توضیحات شناسه API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده
شناسه حساب accountId account در accounts/{account}
شناسه کاربر email_address درون شیء AccountUser email در accounts/{account}/users/{email}

روش‌ها

جدول زیر روش‌های بین Content API برای خرید و Merchant API را مقایسه می‌کند.

API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده موجودی و نکات
accounts.update users.create یک کاربر جدید برای یک حساب کاربری ایجاد می‌کند.
accounts.get users.get یک کاربر واحد را بازیابی می‌کند.
accounts.get users.list لیست تمام کاربران یک حساب کاربری را نشان می‌دهد.
accounts.update users.update حقوق دسترسی کاربر را به‌روزرسانی می‌کند.
accounts.update users.delete کاربر را از یک حساب کاربری حذف می‌کند.

تغییرات جزئی فیلدها

نحوه‌ی استفاده از فیلدها را به صورت زیر به‌روزرسانی کنید:

API محتوا برای خرید رابط برنامه‌نویسی کاربردی (API) فروشنده توضیحات
users ( AccountUser تکرار شده) users ( User تکراری) منبع User اکنون یک منبع سطح بالا با سرویس خاص خود است.
AccountUser.email_address و بخشی از User.name به نام CreateUserRequest.user_id آدرس ایمیل کاربر اکنون بخشی از نام منبع است. آن را در هنگام ایجاد در فیلد user_id مشخص کنید.
AccountUser.admin access_rights: "ADMIN" رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) فیلد بولی admin را با مقدار ADMIN در enum access_rights جایگزین می‌کند.
AccountUser.order_manager ، AccountUser.payments_manager ، AccountUser.payments_analyst access_rights: "STANDARD" رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) این نقش‌ها را با دسترسی STANDARD جایگزین می‌کند.
AccountUser.reporting_manager access_rights: "PERFORMANCE_REPORTING" نقش reporting_manager اکنون دارای حق دسترسی PERFORMANCE_REPORTING است.
AccountUser.read_only access_rights: "READ_ONLY" نقش read_only اکنون دارای حق دسترسی READ_ONLY است.
موجود نیست User.name شامل نام کامل منبع کاربر است، برای مثال، accounts/{account}/users/{email} .
موجود نیست User.state وضعیت دعوت کاربر را نشان می‌دهد که در PENDING یا VERIFIED .