۱ می، ۲۰۲۶
آموزش دریافت توکن دسترسی Admin API شاپیفای (گامبهگام)
اگر میخواهید با Admin API شاپیفای ارتباط برقرار کنید تا محصولات، متاآبجکتها (Metaobjects)، فایلها و موارد دیگر را بخوانید یا بنویسید، به یک توکن دسترسی (Access Token) نیاز دارید. این راهنما شما را با جریان کامل OAuth آشنا میکند: ساخت یک برنامه اختصاصی (Custom App) در داشبورد پارتنر شاپیفای، دریافت کد احراز هویت، و تبدیل آن به یک توکن با استفاده از نرمافزار Postman.
آموزش ویدیویی (مراحل را به صورت تصویری دنبال کنید)
مرحله ۱: ساخت یک Custom App در داشبورد پارتنر شاپیفای
- به داشبورد پارتنر شاپیفای خود بروید و مسیر Apps → Create app را دنبال کنید.
- گزینه Create app manually (ساخت دستی برنامه) را انتخاب کنید.
- یک نام برای آن انتخاب کنید (مثلاً “Admin API Tool”).
- در بخش Configuration، آدرسهای App URL و Allowed redirection URL(s) را تنظیم کنید. برای تست در محیط لوکال (Local)، از آدرس زیر استفاده کنید:
http://localhost - در بخش API scopes، تمام دسترسیهایی که نیاز دارید را انتخاب کنید. موارد رایج عبارتند از:
read_orders, write_orders, read_draft_orders, write_draft_orders, read_customers, write_customers, read_products, write_products, read_price_rules, write_price_rules, read_discounts, write_discounts, read_fulfillments, write_fulfillments, read_locations, read_shopify_payments_payouts, read_shopify_payments_disputes, read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders, read_third_party_fulfillment_orders, write_third_party_fulfillment_orders
- برنامه را ذخیره (Save) کنید. Client ID و Client Secret را کپی کنید؛ در مراحل بعدی به هر دوی آنها نیاز خواهید داشت.
مرحله ۲: درخواست احراز هویت (دریافت کُد)
مرورگر خود را باز کنید و به آدرس (URL) زیر بروید. فراموش نکنید که مقادیر پیشفرض را با اطلاعات واقعی خود جایگزین کنید:
https://YOUR-STORE.myshopify.com/admin/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=http://localhostمثال:
https://saad0011.myshopify.com/admin/oauth/authorize?client_id=ee54bec3ce22bceee7dcf86de570cbb2&redirect_uri=http://localhost- شاپیفای یک صفحه مجوز (Permission screen) به شما نشان میدهد که لیست دسترسیهای درخواستی برنامهتان در آن قرار دارد.
- برای تایید، روی Install app کلیک کنید.
- شما به آدرس
http://localhostریدایرکت (هدایت) خواهید شد (مرورگر یک خطا نشان میدهد، این کاملاً طبیعی است چون هیچ سروری روی لوکالهاست شما در حال اجرا نیست).
آدرس ریدایرکت شده چیزی شبیه به این خواهد بود:
http://localhost/?code=3bb6b41a3aec7c6189473880ff0b2a21&hmac=d6981f1fcf232527f922...&shop=saad0011.myshopify.com×tamp=1771396570پارامتر code را از آدرس URL کپی کنید. این همان کُد احراز هویتِ یکبار مصرف شماست.
مرحله ۳: تبدیل کُد به توکن دسترسی (با استفاده از Postman)
حالا باید یک درخواست POST ارسال کنید تا کُد احراز هویت را با یک توکن دسترسی دائمی مبادله کنید.
نقطه پایانی (Endpoint):
POST https://YOUR-STORE.myshopify.com/admin/oauth/access_tokenپارامترهای کوئری (Query Parameters):
مثال در Postman:
- Method:
POST - URL:
https://saad0011.myshopify.com/admin/oauth/access_token - سه پارامتر بالا را در تب Params (یا مستقیماً در خود URL) اضافه کنید.
روی Send کلیک کنید. پاسخ (Response) سرور یک آبجکت JSON خواهد بود:
{
"access_token": "shpca_************************",
"scope": "write_files,write_metaobject_definitions,write_metaobjects,write_product_listings,write_products"
}مقدار access_token را ذخیره کنید. این همان کلیدی است که در هدر X-Shopify-Access-Token برای تمام درخواستهای بعدی به Admin API ارسال خواهید کرد.
مرحله ۴: ارسال درخواستهای API احراز هویت شده
اکنون با داشتن این توکن دسترسی، میتوانید هرکدام از اندپوینتهای Admin API که مجوز آن را گرفتهاید فراخوانی کنید. مثال با استفاده از curl:
curl -X GET \
"https://saad0011.myshopify.com/admin/api/2024-01/products.json" \
-H "X-Shopify-Access-Token: shpca_************************"یا در نرمافزار Postman، یک هدر (Header) جدید با این مشخصات اضافه کنید:
- Key:
X-Shopify-Access-Token - Value:
shpca_************************
نکات بسیار مهم
- کُد احراز هویت (مرحله ۲) تنها ۱۰ دقیقه اعتبار دارد. پس از دریافت کُد، بلافاصله مرحله ۳ را انجام دهید.
- توکن دسترسی (Access Token) هیچگاه منقضی نمیشود، مگر اینکه برنامه را حذف کنید یا توکن لغو (Revoke) شود.
- توکن را در مکانی امن ذخیره کنید و دقیقاً مانند یک رمز عبور با آن رفتار کنید. هرگز آن را در سیستمهای کنترل نسخه (مثل گیتهاب) آپلود نکنید.
- دسترسیهای این توکن کاملاً محدود به مواردی است که در هنگام ساخت برنامه انتخاب کردهاید.
همین! شما اکنون یک توکن دسترسی Admin API شاپیفای دارید که میتوانید از آن برای خودکارسازی وظایف، همگامسازی دادهها، یا ساخت یکپارچهسازیهای سیستم استفاده کنید. برای مرحله بعدی نیاز به کمک دارید؟ هر زمان که خواستید در واتساپ به من پیام دهید.
