برای استفاده مؤثر از رابط برنامهنویسی کاربردی فروشگاه، درک مفاهیم ثبتنام، احراز هویت و مجوزدهی مهم است. این مفاهیم اهداف متمایزی را در تضمین دسترسی ایمن و صحیح به دادههای مرکز فروشگاه دنبال میکنند.
اصطلاحات
ثبت، احراز هویت و مجوز مرتبط هستند، اما هر کدام معنا و هدف متمایزی دارند.
- احراز هویت : در این فرآیند، سرویس هویت کاربر یا برنامهای که درخواست API میدهد را تأیید میکند. API فروشنده از مکانیسمهای استاندارد گوگل مانند OAuth 2.0 استفاده میکند. برای اطلاعات بیشتر، به بخشهای احراز هویت درخواستها و احراز هویت به عنوان حساب کاربری خود مراجعه کنید.
- مجوزدهی : این فرآیند تعیین میکند که کاربر یا برنامهی احراز هویت شده مجاز به انجام چه اقداماتی با استفاده از حساب مرکز فروشندگان است. این فرآیند به این سوال پاسخ میدهد: «چه کاری میتوانید انجام دهید؟» این کار بر اساس نقشها و مجوزهایی که به کاربر احراز هویت شده در حساب مرکز فروشندگان اعطا شده است، انجام میشود. به عنوان مثال، ممکن است یک کاربر مجاز به خواندن دادههای محصول باشد، اما مجاز به تغییر تنظیمات حساب نباشد.
- ثبتنام : در رابطه با رابط برنامهنویسی کاربردی فروشگاه (Merchant API)، این یک فرآیند راهاندازی یکباره است که به گوگل اجازه میدهد اطلاعیههای خدمات مهم را برای حسابهای تجاری که مدیریت میکنید، برای شما ارسال کند. ثبتنام، آدرسهای ایمیل توسعهدهنده شما را به حساب اصلی مرکز تجاری شما اضافه میکند و آن را به شناسه(های) پروژه گوگل کلود که برای احراز هویت استفاده میکنید، پیوند میدهد. این پیوند به برنامه شما اجازه میدهد تا اطلاعیههای خدمات را برای همه حسابهای تجاری که مدیریت میکنید، دریافت کند. برای اطلاعات بیشتر، به ایجاد یک پروژه گوگل کلود مراجعه کنید.
ثبت نام
فرآیند ثبت نام برای فعال کردن برنامه شما جهت استفاده از Merchant API بسیار مهم است. در اینجا مواردی که باید بدانید آورده شده است:
پیشنیازها
ثبت نام برای استفاده از Merchant API مستلزم موارد زیر است:
- حساب مرکز تجاری : شما به یک حساب مرکز تجاری موجود نیاز دارید.
- دسترسی ادمین: حساب کاربری گوگلی که برای شروع فرآیند ثبت نام استفاده میکنید، باید در حساب مرکز تجاری که ثبت میکنید، دارای دسترسی ادمین باشد.
- پروژه ابری گوگل : برنامه شما باید با یک پروژه ابری گوگل مرتبط باشد. این پروژه اعتبارنامههای لازم (مانند شناسههای کلاینت OAuth 2.0) را برای تأیید اعتبار برنامه شما فراهم میکند.
چرا نمیتوانید یک پروژه مشترک Google Cloud ثبت کنید؟
ابزارهایی مانند Google OAuth Playground و APIs Explorer از پروژههای مشترک Google Cloud متعلق به گوگل استفاده میکنند. شما نمیتوانید در پروژههای مشترک ثبتنام کنید زیرا:
- آنها برای آزمایش و اکتشاف در نظر گرفته شدهاند، نه برای هویت برنامه کاربردی در مرحله تولید.
- ثبت آنها به معنای ایجاد ارتباط بین ابزار مشترک و دادههای خاص مرکز فروشندگان شما خواهد بود و ممکن است منجر به ارتباطات ناخواسته شود.
برنامه شما به پروژه اختصاصی گوگل کلود خود نیاز دارد تا ارتباطات API فروشنده که گوگل برای شما ارسال میکند، برای استفاده واقعی شما مرتبط باقی بماند.
با این وجود، میتوانید از برنامههای وب OAuth Playground و API Explorer برای استفاده از Merchant API برای آزمایش و موارد استفاده غیر تولیدی استفاده کنید.
شناسه پروژه گوگل کلود خود را پیدا کنید
میتوانید شناسه پروژه و شماره پروژه خود را در کنسول گوگل کلود پیدا کنید. برای جزئیات بیشتر، به بخش «یافتن نام، شماره و شناسه پروژه » مراجعه کنید.
تماس ثبت نام را برقرار کنید
با استفاده از متد registerGcp در زیر-API Accounts ، ثبتنام کنید. این فراخوانی، شماره پروژه گوگل کلود شما را با حساب مرکز فروشندگان مرتبط میکند.
در طول این فرآیند، شما باید یک آدرس ایمیل مرتبط با یک کاربر خاص که برای فراخوانی API از آن استفاده میکنید، ارائه دهید. این ایمیل باید متعلق به کاربری با دسترسی ادمین به حساب مرکز فروشندگان باشد.
درباره فیلد ایمیل
ارتباط موثر کلید اصلی است. گوگل بهروزرسانیهای مهم، اطلاعیههای خدمات اجباری (MSA)، نظرسنجیهای توسعهدهندگان و سایر فرصتهای مرتبط با API فروشنده را ارسال میکند. مدیریت صحیح تماس تضمین میکند که این موارد به افراد مناسب برسد.
- هدف : گوگل از این آدرس ایمیل به عنوان مخاطب اصلی برای ارتباطات مرتبط با API استفاده میکند.
- ایمیل چه کسی : این باید آدرس ایمیل یک توسعهدهنده یا یک رابط فنی کلیدی باشد که مسئول ادغام API است.
- بهترین شیوهها :
- انجام دهید : از آدرس ایمیل شرکتی یک فرد استفاده کنید.
- انجام ندهید : از نامهای مستعار عمومی گروه یا ایمیلهای حسابهای کاربری سرویس استفاده نکنید. هدف ما ارتباطات برای گیرندگان انسانی است.
منبع users برای مدیریت مخاطبین
در حالی که آدرس ایمیل در فراخوانی ثبتنام، یک مخاطب اولیه را تعیین میکند، راه قویتر برای مدیریت مخاطبین و مجوزها، استفاده از منبع accounts.users از رابط برنامهنویسی کاربردی فروشنده یا تنظیمات مدیریت کاربر در رابط کاربری مرکز فروشنده است. برای اطلاعات بیشتر در مورد استفاده از مرکز فروشنده، به مدیریت افراد در حساب خود مراجعه کنید.
از این امکانات به شرح زیر بهره ببرید:
- اضافه کردن همه توسعهدهندگان : توسعهدهندگانی که روی ادغام API کار میکنند را به عنوان کاربران حساب مرکز فروشندگان اضافه کنید.
- اختصاص نقش
API_DEVELOPER: علاوه بر نقشهای استاندارد ( Admin ، Standard )، میتوانید نقشAPI_DEVELOPERرا به کاربران اختصاص دهید. به طور خاص، این نقش را به کاربرانی اختصاص دهید که باید ارتباطات مرتبط با API را دریافت کنند. میتوانید آن را با نقشهای دیگر ترکیب کنید. - مزایا :
- جداسازی واضح : مدیریت تماس API را از ثبت نام یکباره جدا میکند.
- انعطافپذیری : بهروزرسانی مخاطبین با تغییر اعضای تیم.
- ارتباط هدفمند : تضمین میکند که اخبار مربوط به API به افراد مرتبط میرسد.
حتی اگر هنگام ثبت نام آدرس ایمیل ارائه داده باشید، اکیداً توصیه میکنیم با اضافه کردن کاربرانی با نقش API_DEVELOPER ، مخاطبین API را مدیریت کنید.
منابع
برای اطلاعات بیشتر، به موارد زیر مراجعه کنید: