در این بخش با روش تایید هویت و دسترسی به وب سرویس های ثمین آشنا خواهید شد. API های ثمین در سه دسته زیر قرار می گیرند:
GAPI
api های عمومی ثمین در این دسته قرار دارند. برای مثال دریافت مقالات سایت از طریق این وب سرویس امکان پذیر است. دسترسی از طریق این api ها بدون نیاز به Authentication خواهد بود.
XAPI
از این api ها برای ایجاد وب اپلیکیشن و یا هر نوع اپلیکیشن فروشگاهی دیگری می توانید استفاده نمایید. از طریق api های این دسته، دسترسی به اطلاعات فروشگاه، محصولات، دسته بندی ها، خرید و موارد دیگری که مرتبط با دسترسی خریدار و فروشگاه است را خواهید داشت.
API
این بخش امکان دسترسی و مدیریت فروشگاه از طریق api را برای شما و یا سرویس های خارجی متصل به فروشگاه فراهم می آورد. از طریق این api ها قادر به ایجاد محصول، تغییر میزان موجودی، ویرایش مطالب، دریافت نطرات، دریافت سفارشات و بسیاری موارد دیگر خواهید بود. از api های این دسته برای به روزرسانی فروشگاه ثمین از طریق فروشگاه های قدیمی و یا اتصال اپلیکیشن و سرویس های خود به فروشگاهتان می توانید استفاده نمایید.
برای اتصال به API ثمین شما نیاز به یک کلید دسترسی Access token خواهید داشت. این توکن به روش های مختلفی طبق استاندارد OAuth 2.0 قابل ایجاد است. بیایید با ساده ترین روش این کار را شروع نماییم. در این روش شما یک کلید دسترسی شخصی برای اتصال به حساب کاربری ثمینتان خواهید ساخت. این روش برای آزمایش اپلیکیشن و در مرحله توسعه سرویس یا اپلیکیشنتان مفید خواهد بود.
وارد داشبورد خود شده و از پنل اصلی وارد بخش دسترسی ها > کلید شخصی شوید.
سپس بر روی گزینه ساخت توکن جدید کلیک نمایید. صفحه ای برای وارد نمودن یک نام مستعار و انتخاب محدوده های دسترسی این توکن به شما نمایش داده خواهد شد. دسترسی های قرمز محدوده های کلیدی در حساب شما هستند و امکان ایجاد تغییرات عمده در فروشگاه، محصولات و حساب کاربری شما را فراهم می آورند.
توجه: برای توسعه سرویس خود بهتر است از یک فروشگاه آزمایشی شروع نمایید.
پس از کلیک بر روی گزینه ایجاد، Access token ایجاد و به شما نمایش داده خواهد شد. دقت نمایید این توکن تنها یک بار نمایش داده شده و امکان دریافت مجدد آن وجود ندارد.
کلید فوق را کپی نمایید. از این کلید در ارسال درخواست ها و برای تایید هویت استفاده خواهید نمود. برای مثال برای دریافت لیست محصولات یک فروشگاه توکن فوق را به روش زیر در header درخواست خود قرار دهید. به قرار گیری عبارت Bearer پیش از کلید دقت نمایید.
برای اطلاع بیشتر به مستندات API در این بخش مراجعه نمایید.