توفر هذه المكتبة دعمًا لتطبيقات Ruby Shopify للوصول إلى API Admin Shopify ، من خلال تسهيل إجراء الإجراءات التالية:
بالإضافة إلى واجهة برمجة تطبيقات المسؤول ، تتيح هذه المكتبة أيضًا الاستعلام عن واجهة برمجة تطبيقات واجهة المتجر.
يمكنك استخدام هذه المكتبة في أي تطبيق له الواجهة الخلفية Ruby ، نظرًا لأنها لا تعتمد على أي إطار محدد - يمكنك تضمينها إلى جانب المكدس المفضل لديك واستخدام الميزات التي تحتاجها لإنشاء تطبيقك.
ملاحظة : تنطبق هذه التعليمات على V10 أو الأحدث من هذه الحزمة. إذا كنت تقوم بتشغيل V9 في تطبيقك ، فيمكنك العثور على الوثائق في هذا الفرع.
إذا كنت تستخدم في إطار Rails ، فإننا نوصيك بشدة باستخدام GEM Shopify_app للتفاعل مع هذه الأحجار الكريمة. تتم إدارة المصادقة ، وتخزين الجلسة ، وتسجيل WebHook ، والمسارات الأخرى التي يتم تنفيذها بشكل متكرر في تلك الأحجار الكريمة مع تكوينات سهلة الاستخدام.
لمتابعة أدلة الاستخدام هذه ، ستحتاج إلى:
أضف ما يلي إلى gemfile الخاص بك:
gem " shopify_api "
أو استخدم Bundler:
bundle add shopify_api
ابدأ بتوضيح ShopifyAPI::Context
مع معلمات تطبيقك عن طريق الاتصال ShopifyAPI::Context.setup
(مثال أدناه) عند بدء تشغيل التطبيق الخاص بك (على سبيل المثال application.rb
في تطبيق Rails).
ShopifyAPI :: Context . setup (
api_key : "<api-key>" ,
api_secret_key : "<api-secret-key>" ,
host : "<https://application-host-name.com>" ,
scope : "read_orders,read_products,etc" ,
is_embedded : true , # Set to true if you are building an embedded app
api_version : "2022-01" , # The version of the API you would like to use
is_private : false , # Set to true if you have an existing private app
)
تحتاج إلى المرور عبر OAUTH كما هو موضح هنا لإنشاء جلسات للمتاجر التي تستخدم تطبيقك. تحاول GEM API SHOPIFY أن تجعل هذا الأمر سهلاً من خلال توفير وظائف للبدء وإكمال عملية OAUTH. انظر Doc Oauth للحصول على تعليمات حول كيفية استخدام هذه.
إذا كنت تنوي استخدام Webhooks في التطبيق الخاص بك ، فابع الخطوات الواردة في DOC WebHooks للحصول على إرشادات حول تسجيل Webhooks ومعالجتها.
بمجرد أن يتمكن تطبيقك من أداء OAUTH ، يمكنه الآن إجراء مكالمات API Shopify المصادقة ، راجع مستندات:
انظر break_changes_for_v15
انظر Breaking_changes_for_v10
انظر break_changes_for_older_versions
بعد استنساخ المستودع ، يمكنك تثبيت التبعيات باستخدام Bundler:
bundle install
لتشغيل الاختبارات الآلية:
bundle exec rake test
نحن نستخدم Rubocop لترتيب/تنسيق الرمز. يمكنك تشغيله مع الأمر التالي:
bundle exec rubocop